Documentation
¶
Overview ¶
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Index ¶
- Constants
- type AccountKeyMetadata_STATUS
- type AnalyticalStorageConfiguration
- type AnalyticalStorageConfiguration_STATUS
- type AnalyticalStorageSchemaType
- type AnalyticalStorageSchemaType_STATUS
- type ApiProperties
- type ApiProperties_STATUS
- type ApiProperties_ServerVersion
- type ApiProperties_ServerVersion_STATUS
- type AutoUpgradePolicyResource
- type AutoUpgradePolicyResource_STATUS
- type AutoscaleSettings
- type AutoscaleSettingsResource
- type AutoscaleSettingsResource_STATUS
- type AutoscaleSettings_STATUS
- type BackupPolicy
- type BackupPolicyMigrationState
- type BackupPolicyMigrationState_STATUS
- type BackupPolicyMigrationStatus
- type BackupPolicyMigrationStatus_STATUS
- type BackupPolicyType
- type BackupPolicyType_STATUS
- type BackupPolicy_STATUS
- type BackupStorageRedundancy
- type BackupStorageRedundancy_STATUS
- type Capability
- type Capability_STATUS
- type Capacity
- type Capacity_STATUS
- type ClientEncryptionIncludedPath
- type ClientEncryptionIncludedPath_STATUS
- type ClientEncryptionPolicy
- type ClientEncryptionPolicy_STATUS
- type CompositePath
- type CompositePath_Order
- type CompositePath_Order_STATUS
- type CompositePath_STATUS
- type ComputedProperty
- type ComputedProperty_STATUS
- type ConflictResolutionPolicy
- type ConflictResolutionPolicy_Mode
- type ConflictResolutionPolicy_Mode_STATUS
- type ConflictResolutionPolicy_STATUS
- type ConnectorOffer
- type ConnectorOffer_STATUS
- type ConsistencyPolicy
- type ConsistencyPolicy_DefaultConsistencyLevel
- type ConsistencyPolicy_DefaultConsistencyLevel_STATUS
- type ConsistencyPolicy_STATUS
- type ContainerPartitionKey
- type ContainerPartitionKey_Kind
- type ContainerPartitionKey_Kind_STATUS
- type ContainerPartitionKey_STATUS
- type ContinuousModeBackupPolicy
- type ContinuousModeBackupPolicy_STATUS
- type ContinuousModeBackupPolicy_Type
- type ContinuousModeBackupPolicy_Type_STATUS
- type ContinuousModeProperties
- type ContinuousModeProperties_STATUS
- type ContinuousTier
- type ContinuousTier_STATUS
- type CorsPolicy
- type CorsPolicy_STATUS
- type CreateMode
- type CreateMode_STATUS
- type CreateUpdateOptions
- type DatabaseAccountCreateUpdateProperties
- type DatabaseAccountGetProperties_STATUS
- type DatabaseAccountKeysMetadata_STATUS
- type DatabaseAccountOfferType
- type DatabaseAccountOfferType_STATUS
- type DatabaseAccount_Kind_STATUS
- type DatabaseAccount_Kind_Spec
- type DatabaseAccount_STATUS
- type DatabaseAccount_Spec
- type DatabaseRestoreResource
- type DatabaseRestoreResource_STATUS
- type ExcludedPath
- type ExcludedPath_STATUS
- type FailoverPolicy_STATUS
- type GremlinDatabaseRestoreResource
- type GremlinDatabaseRestoreResource_STATUS
- type IncludedPath
- type IncludedPath_STATUS
- type Indexes
- type Indexes_DataType
- type Indexes_DataType_STATUS
- type Indexes_Kind
- type Indexes_Kind_STATUS
- type Indexes_STATUS
- type IndexingPolicy
- type IndexingPolicy_IndexingMode
- type IndexingPolicy_IndexingMode_STATUS
- type IndexingPolicy_STATUS
- type IpAddressOrRange
- type IpAddressOrRange_STATUS
- type Location
- type Location_STATUS
- type ManagedServiceIdentity
- type ManagedServiceIdentity_STATUS
- type ManagedServiceIdentity_Type
- type ManagedServiceIdentity_Type_STATUS
- type ManagedServiceIdentity_UserAssignedIdentities_STATUS
- type MinimalTlsVersion
- type MinimalTlsVersion_STATUS
- type MongoDBCollectionCreateUpdateProperties
- type MongoDBCollectionGetProperties_Resource_STATUS
- type MongoDBCollectionGetProperties_STATUS
- type MongoDBCollectionResource
- type MongoDBDatabaseCreateUpdateProperties
- type MongoDBDatabaseGetProperties_Resource_STATUS
- type MongoDBDatabaseGetProperties_STATUS
- type MongoDBDatabaseResource
- type MongoIndex
- type MongoIndexKeys
- type MongoIndexKeys_STATUS
- type MongoIndexOptions
- type MongoIndexOptions_STATUS
- type MongoIndex_STATUS
- type MongoUserDefinitionResource
- type MongoUserDefinitionResource_STATUS
- type MongodbDatabaseCollectionThroughputSetting_STATUS
- type MongodbDatabaseCollectionThroughputSetting_Spec
- type MongodbDatabaseCollection_STATUS
- type MongodbDatabaseCollection_Spec
- type MongodbDatabaseThroughputSetting_STATUS
- type MongodbDatabaseThroughputSetting_Spec
- type MongodbDatabase_STATUS
- type MongodbDatabase_Spec
- type MongodbUserDefinition_STATUS
- type MongodbUserDefinition_Spec
- type NetworkAclBypass
- type NetworkAclBypass_STATUS
- type OptionsResource_STATUS
- type PeriodicModeBackupPolicy
- type PeriodicModeBackupPolicy_STATUS
- type PeriodicModeBackupPolicy_Type
- type PeriodicModeBackupPolicy_Type_STATUS
- type PeriodicModeProperties
- type PeriodicModeProperties_STATUS
- type PrivateEndpointConnection_STATUS
- type PublicNetworkAccess
- type PublicNetworkAccess_STATUS
- type RestoreParameters
- type RestoreParametersBase
- type RestoreParametersBase_STATUS
- type RestoreParameters_RestoreMode
- type RestoreParameters_RestoreMode_STATUS
- type RestoreParameters_STATUS
- type Role
- type Role_STATUS
- type SpatialSpec
- type SpatialSpec_STATUS
- type SpatialType
- type SpatialType_STATUS
- type SqlContainerCreateUpdateProperties
- type SqlContainerGetProperties_Resource_STATUS
- type SqlContainerGetProperties_STATUS
- type SqlContainerResource
- type SqlDatabaseContainerStoredProcedure_STATUS
- type SqlDatabaseContainerStoredProcedure_Spec
- type SqlDatabaseContainerThroughputSetting_STATUS
- type SqlDatabaseContainerThroughputSetting_Spec
- type SqlDatabaseContainerTrigger_STATUS
- type SqlDatabaseContainerTrigger_Spec
- type SqlDatabaseContainerUserDefinedFunction_STATUS
- type SqlDatabaseContainerUserDefinedFunction_Spec
- type SqlDatabaseContainer_STATUS
- type SqlDatabaseContainer_Spec
- type SqlDatabaseCreateUpdateProperties
- type SqlDatabaseGetProperties_Resource_STATUS
- type SqlDatabaseGetProperties_STATUS
- type SqlDatabaseResource
- type SqlDatabaseThroughputSetting_STATUS
- type SqlDatabaseThroughputSetting_Spec
- type SqlDatabase_STATUS
- type SqlDatabase_Spec
- type SqlRoleAssignmentResource
- type SqlRoleAssignmentResource_STATUS
- type SqlRoleAssignment_STATUS
- type SqlRoleAssignment_Spec
- type SqlStoredProcedureCreateUpdateProperties
- type SqlStoredProcedureGetProperties_Resource_STATUS
- type SqlStoredProcedureGetProperties_STATUS
- type SqlStoredProcedureResource
- type SqlTriggerCreateUpdateProperties
- type SqlTriggerGetProperties_Resource_STATUS
- type SqlTriggerGetProperties_Resource_TriggerOperation_STATUS
- type SqlTriggerGetProperties_Resource_TriggerType_STATUS
- type SqlTriggerGetProperties_STATUS
- type SqlTriggerResource
- type SqlTriggerResource_TriggerOperation
- type SqlTriggerResource_TriggerType
- type SqlUserDefinedFunctionCreateUpdateProperties
- type SqlUserDefinedFunctionGetProperties_Resource_STATUS
- type SqlUserDefinedFunctionGetProperties_STATUS
- type SqlUserDefinedFunctionResource
- type SystemData_CreatedByType_STATUS
- type SystemData_LastModifiedByType_STATUS
- type SystemData_STATUS
- type ThroughputPolicyResource
- type ThroughputPolicyResource_STATUS
- type ThroughputSettingsGetProperties_Resource_STATUS
- type ThroughputSettingsGetProperties_STATUS
- type ThroughputSettingsResource
- type ThroughputSettingsUpdateProperties
- type UniqueKey
- type UniqueKeyPolicy
- type UniqueKeyPolicy_STATUS
- type UniqueKey_STATUS
- type UserAssignedIdentityDetails
- type VirtualNetworkRule
- type VirtualNetworkRule_STATUS
Constants ¶
const ( DatabaseAccount_Kind_Spec_GlobalDocumentDB = DatabaseAccount_Kind_Spec("GlobalDocumentDB") DatabaseAccount_Kind_Spec_MongoDB = DatabaseAccount_Kind_Spec("MongoDB") DatabaseAccount_Kind_Spec_Parse = DatabaseAccount_Kind_Spec("Parse") )
const ( CreateMode_Default = CreateMode("Default") CreateMode_Restore = CreateMode("Restore") )
const ( ManagedServiceIdentity_Type_None = ManagedServiceIdentity_Type("None") ManagedServiceIdentity_Type_SystemAssigned = ManagedServiceIdentity_Type("SystemAssigned") ManagedServiceIdentity_Type_SystemAssignedUserAssigned = ManagedServiceIdentity_Type("SystemAssigned,UserAssigned") ManagedServiceIdentity_Type_UserAssigned = ManagedServiceIdentity_Type("UserAssigned") )
const ( MinimalTlsVersion_Tls = MinimalTlsVersion("Tls") MinimalTlsVersion_Tls11 = MinimalTlsVersion("Tls11") MinimalTlsVersion_Tls12 = MinimalTlsVersion("Tls12") )
const ( NetworkAclBypass_AzureServices = NetworkAclBypass("AzureServices") NetworkAclBypass_None = NetworkAclBypass("None") )
const ( PublicNetworkAccess_Disabled = PublicNetworkAccess("Disabled") PublicNetworkAccess_Enabled = PublicNetworkAccess("Enabled") PublicNetworkAccess_SecuredByPerimeter = PublicNetworkAccess("SecuredByPerimeter") )
const ( AnalyticalStorageSchemaType_FullFidelity = AnalyticalStorageSchemaType("FullFidelity") AnalyticalStorageSchemaType_WellDefined = AnalyticalStorageSchemaType("WellDefined") )
const ( ApiProperties_ServerVersion_32 = ApiProperties_ServerVersion("3.2") ApiProperties_ServerVersion_36 = ApiProperties_ServerVersion("3.6") ApiProperties_ServerVersion_40 = ApiProperties_ServerVersion("4.0") ApiProperties_ServerVersion_42 = ApiProperties_ServerVersion("4.2") ApiProperties_ServerVersion_50 = ApiProperties_ServerVersion("5.0") ApiProperties_ServerVersion_60 = ApiProperties_ServerVersion("6.0") ApiProperties_ServerVersion_70 = ApiProperties_ServerVersion("7.0") )
const ( ConsistencyPolicy_DefaultConsistencyLevel_BoundedStaleness = ConsistencyPolicy_DefaultConsistencyLevel("BoundedStaleness") ConsistencyPolicy_DefaultConsistencyLevel_ConsistentPrefix = ConsistencyPolicy_DefaultConsistencyLevel("ConsistentPrefix") ConsistencyPolicy_DefaultConsistencyLevel_Eventual = ConsistencyPolicy_DefaultConsistencyLevel("Eventual") ConsistencyPolicy_DefaultConsistencyLevel_Session = ConsistencyPolicy_DefaultConsistencyLevel("Session") ConsistencyPolicy_DefaultConsistencyLevel_Strong = ConsistencyPolicy_DefaultConsistencyLevel("Strong") )
const ( BackupPolicyMigrationStatus_Completed = BackupPolicyMigrationStatus("Completed") BackupPolicyMigrationStatus_Failed = BackupPolicyMigrationStatus("Failed") BackupPolicyMigrationStatus_InProgress = BackupPolicyMigrationStatus("InProgress") BackupPolicyMigrationStatus_Invalid = BackupPolicyMigrationStatus("Invalid") )
const ( BackupPolicyType_Continuous = BackupPolicyType("Continuous") BackupPolicyType_Periodic = BackupPolicyType("Periodic") )
const ( BackupStorageRedundancy_Geo = BackupStorageRedundancy("Geo") BackupStorageRedundancy_Local = BackupStorageRedundancy("Local") BackupStorageRedundancy_Zone = BackupStorageRedundancy("Zone") )
const ( ContinuousTier_Continuous30Days = ContinuousTier("Continuous30Days") ContinuousTier_Continuous7Days = ContinuousTier("Continuous7Days") )
const ( DatabaseAccount_Kind_STATUS_GlobalDocumentDB = DatabaseAccount_Kind_STATUS("GlobalDocumentDB") DatabaseAccount_Kind_STATUS_MongoDB = DatabaseAccount_Kind_STATUS("MongoDB") DatabaseAccount_Kind_STATUS_Parse = DatabaseAccount_Kind_STATUS("Parse") )
const ( CreateMode_STATUS_Default = CreateMode_STATUS("Default") CreateMode_STATUS_Restore = CreateMode_STATUS("Restore") )
const ( ManagedServiceIdentity_Type_STATUS_None = ManagedServiceIdentity_Type_STATUS("None") ManagedServiceIdentity_Type_STATUS_SystemAssigned = ManagedServiceIdentity_Type_STATUS("SystemAssigned") ManagedServiceIdentity_Type_STATUS_SystemAssignedUserAssigned = ManagedServiceIdentity_Type_STATUS("SystemAssigned,UserAssigned") ManagedServiceIdentity_Type_STATUS_UserAssigned = ManagedServiceIdentity_Type_STATUS("UserAssigned") )
const ( MinimalTlsVersion_STATUS_Tls = MinimalTlsVersion_STATUS("Tls") MinimalTlsVersion_STATUS_Tls11 = MinimalTlsVersion_STATUS("Tls11") MinimalTlsVersion_STATUS_Tls12 = MinimalTlsVersion_STATUS("Tls12") )
const ( NetworkAclBypass_STATUS_AzureServices = NetworkAclBypass_STATUS("AzureServices") NetworkAclBypass_STATUS_None = NetworkAclBypass_STATUS("None") )
const ( PublicNetworkAccess_STATUS_Disabled = PublicNetworkAccess_STATUS("Disabled") PublicNetworkAccess_STATUS_Enabled = PublicNetworkAccess_STATUS("Enabled") PublicNetworkAccess_STATUS_SecuredByPerimeter = PublicNetworkAccess_STATUS("SecuredByPerimeter") )
const ( SystemData_CreatedByType_STATUS_Application = SystemData_CreatedByType_STATUS("Application") SystemData_CreatedByType_STATUS_Key = SystemData_CreatedByType_STATUS("Key") SystemData_CreatedByType_STATUS_ManagedIdentity = SystemData_CreatedByType_STATUS("ManagedIdentity") SystemData_CreatedByType_STATUS_User = SystemData_CreatedByType_STATUS("User") )
const ( SystemData_LastModifiedByType_STATUS_Application = SystemData_LastModifiedByType_STATUS("Application") SystemData_LastModifiedByType_STATUS_Key = SystemData_LastModifiedByType_STATUS("Key") SystemData_LastModifiedByType_STATUS_ManagedIdentity = SystemData_LastModifiedByType_STATUS("ManagedIdentity") SystemData_LastModifiedByType_STATUS_User = SystemData_LastModifiedByType_STATUS("User") )
const ( AnalyticalStorageSchemaType_STATUS_FullFidelity = AnalyticalStorageSchemaType_STATUS("FullFidelity") AnalyticalStorageSchemaType_STATUS_WellDefined = AnalyticalStorageSchemaType_STATUS("WellDefined") )
const ( ApiProperties_ServerVersion_STATUS_32 = ApiProperties_ServerVersion_STATUS("3.2") ApiProperties_ServerVersion_STATUS_36 = ApiProperties_ServerVersion_STATUS("3.6") ApiProperties_ServerVersion_STATUS_40 = ApiProperties_ServerVersion_STATUS("4.0") ApiProperties_ServerVersion_STATUS_42 = ApiProperties_ServerVersion_STATUS("4.2") ApiProperties_ServerVersion_STATUS_50 = ApiProperties_ServerVersion_STATUS("5.0") ApiProperties_ServerVersion_STATUS_60 = ApiProperties_ServerVersion_STATUS("6.0") ApiProperties_ServerVersion_STATUS_70 = ApiProperties_ServerVersion_STATUS("7.0") )
const ( ConsistencyPolicy_DefaultConsistencyLevel_STATUS_BoundedStaleness = ConsistencyPolicy_DefaultConsistencyLevel_STATUS("BoundedStaleness") ConsistencyPolicy_DefaultConsistencyLevel_STATUS_ConsistentPrefix = ConsistencyPolicy_DefaultConsistencyLevel_STATUS("ConsistentPrefix") ConsistencyPolicy_DefaultConsistencyLevel_STATUS_Eventual = ConsistencyPolicy_DefaultConsistencyLevel_STATUS("Eventual") ConsistencyPolicy_DefaultConsistencyLevel_STATUS_Session = ConsistencyPolicy_DefaultConsistencyLevel_STATUS("Session") ConsistencyPolicy_DefaultConsistencyLevel_STATUS_Strong = ConsistencyPolicy_DefaultConsistencyLevel_STATUS("Strong") )
const ( BackupPolicyMigrationStatus_STATUS_Completed = BackupPolicyMigrationStatus_STATUS("Completed") BackupPolicyMigrationStatus_STATUS_Failed = BackupPolicyMigrationStatus_STATUS("Failed") BackupPolicyMigrationStatus_STATUS_InProgress = BackupPolicyMigrationStatus_STATUS("InProgress") BackupPolicyMigrationStatus_STATUS_Invalid = BackupPolicyMigrationStatus_STATUS("Invalid") )
const ( BackupPolicyType_STATUS_Continuous = BackupPolicyType_STATUS("Continuous") BackupPolicyType_STATUS_Periodic = BackupPolicyType_STATUS("Periodic") )
const ( BackupStorageRedundancy_STATUS_Geo = BackupStorageRedundancy_STATUS("Geo") BackupStorageRedundancy_STATUS_Local = BackupStorageRedundancy_STATUS("Local") BackupStorageRedundancy_STATUS_Zone = BackupStorageRedundancy_STATUS("Zone") )
const ( ContinuousTier_STATUS_Continuous30Days = ContinuousTier_STATUS("Continuous30Days") ContinuousTier_STATUS_Continuous7Days = ContinuousTier_STATUS("Continuous7Days") )
const ( ConflictResolutionPolicy_Mode_Custom = ConflictResolutionPolicy_Mode("Custom") ConflictResolutionPolicy_Mode_LastWriterWins = ConflictResolutionPolicy_Mode("LastWriterWins") )
const ( ContainerPartitionKey_Kind_Hash = ContainerPartitionKey_Kind("Hash") ContainerPartitionKey_Kind_MultiHash = ContainerPartitionKey_Kind("MultiHash") ContainerPartitionKey_Kind_Range = ContainerPartitionKey_Kind("Range") )
const ( IndexingPolicy_IndexingMode_Consistent = IndexingPolicy_IndexingMode("consistent") IndexingPolicy_IndexingMode_Lazy = IndexingPolicy_IndexingMode("lazy") IndexingPolicy_IndexingMode_None = IndexingPolicy_IndexingMode("none") )
const ( CompositePath_Order_Ascending = CompositePath_Order("ascending") CompositePath_Order_Descending = CompositePath_Order("descending") )
const ( SpatialType_LineString = SpatialType("LineString") SpatialType_MultiPolygon = SpatialType("MultiPolygon") SpatialType_Point = SpatialType("Point") SpatialType_Polygon = SpatialType("Polygon") )
const ( Indexes_DataType_LineString = Indexes_DataType("LineString") Indexes_DataType_MultiPolygon = Indexes_DataType("MultiPolygon") Indexes_DataType_Number = Indexes_DataType("Number") Indexes_DataType_Point = Indexes_DataType("Point") Indexes_DataType_Polygon = Indexes_DataType("Polygon") Indexes_DataType_String = Indexes_DataType("String") )
const ( Indexes_Kind_Hash = Indexes_Kind("Hash") Indexes_Kind_Range = Indexes_Kind("Range") Indexes_Kind_Spatial = Indexes_Kind("Spatial") )
const ( ConflictResolutionPolicy_Mode_STATUS_Custom = ConflictResolutionPolicy_Mode_STATUS("Custom") ConflictResolutionPolicy_Mode_STATUS_LastWriterWins = ConflictResolutionPolicy_Mode_STATUS("LastWriterWins") )
const ( ContainerPartitionKey_Kind_STATUS_Hash = ContainerPartitionKey_Kind_STATUS("Hash") ContainerPartitionKey_Kind_STATUS_MultiHash = ContainerPartitionKey_Kind_STATUS("MultiHash") ContainerPartitionKey_Kind_STATUS_Range = ContainerPartitionKey_Kind_STATUS("Range") )
const ( IndexingPolicy_IndexingMode_STATUS_Consistent = IndexingPolicy_IndexingMode_STATUS("consistent") IndexingPolicy_IndexingMode_STATUS_Lazy = IndexingPolicy_IndexingMode_STATUS("lazy") IndexingPolicy_IndexingMode_STATUS_None = IndexingPolicy_IndexingMode_STATUS("none") )
const ( CompositePath_Order_STATUS_Ascending = CompositePath_Order_STATUS("ascending") CompositePath_Order_STATUS_Descending = CompositePath_Order_STATUS("descending") )
const ( SpatialType_STATUS_LineString = SpatialType_STATUS("LineString") SpatialType_STATUS_MultiPolygon = SpatialType_STATUS("MultiPolygon") SpatialType_STATUS_Point = SpatialType_STATUS("Point") SpatialType_STATUS_Polygon = SpatialType_STATUS("Polygon") )
const ( Indexes_DataType_STATUS_LineString = Indexes_DataType_STATUS("LineString") Indexes_DataType_STATUS_MultiPolygon = Indexes_DataType_STATUS("MultiPolygon") Indexes_DataType_STATUS_Number = Indexes_DataType_STATUS("Number") Indexes_DataType_STATUS_Point = Indexes_DataType_STATUS("Point") Indexes_DataType_STATUS_Polygon = Indexes_DataType_STATUS("Polygon") Indexes_DataType_STATUS_String = Indexes_DataType_STATUS("String") )
const ( Indexes_Kind_STATUS_Hash = Indexes_Kind_STATUS("Hash") Indexes_Kind_STATUS_Range = Indexes_Kind_STATUS("Range") Indexes_Kind_STATUS_Spatial = Indexes_Kind_STATUS("Spatial") )
const ( SqlTriggerResource_TriggerOperation_All = SqlTriggerResource_TriggerOperation("All") SqlTriggerResource_TriggerOperation_Create = SqlTriggerResource_TriggerOperation("Create") SqlTriggerResource_TriggerOperation_Delete = SqlTriggerResource_TriggerOperation("Delete") SqlTriggerResource_TriggerOperation_Replace = SqlTriggerResource_TriggerOperation("Replace") SqlTriggerResource_TriggerOperation_Update = SqlTriggerResource_TriggerOperation("Update") )
const ( SqlTriggerResource_TriggerType_Post = SqlTriggerResource_TriggerType("Post") SqlTriggerResource_TriggerType_Pre = SqlTriggerResource_TriggerType("Pre") )
const ( SqlTriggerGetProperties_Resource_TriggerOperation_STATUS_All = SqlTriggerGetProperties_Resource_TriggerOperation_STATUS("All") SqlTriggerGetProperties_Resource_TriggerOperation_STATUS_Create = SqlTriggerGetProperties_Resource_TriggerOperation_STATUS("Create") SqlTriggerGetProperties_Resource_TriggerOperation_STATUS_Delete = SqlTriggerGetProperties_Resource_TriggerOperation_STATUS("Delete") SqlTriggerGetProperties_Resource_TriggerOperation_STATUS_Replace = SqlTriggerGetProperties_Resource_TriggerOperation_STATUS("Replace") SqlTriggerGetProperties_Resource_TriggerOperation_STATUS_Update = SqlTriggerGetProperties_Resource_TriggerOperation_STATUS("Update") )
const ( SqlTriggerGetProperties_Resource_TriggerType_STATUS_Post = SqlTriggerGetProperties_Resource_TriggerType_STATUS("Post") SqlTriggerGetProperties_Resource_TriggerType_STATUS_Pre = SqlTriggerGetProperties_Resource_TriggerType_STATUS("Pre") )
const ConnectorOffer_STATUS_Small = ConnectorOffer_STATUS("Small")
const ConnectorOffer_Small = ConnectorOffer("Small")
const ContinuousModeBackupPolicy_Type_Continuous = ContinuousModeBackupPolicy_Type("Continuous")
const ContinuousModeBackupPolicy_Type_STATUS_Continuous = ContinuousModeBackupPolicy_Type_STATUS("Continuous")
const DatabaseAccountOfferType_STATUS_Standard = DatabaseAccountOfferType_STATUS("Standard")
const DatabaseAccountOfferType_Standard = DatabaseAccountOfferType("Standard")
const PeriodicModeBackupPolicy_Type_Periodic = PeriodicModeBackupPolicy_Type("Periodic")
const PeriodicModeBackupPolicy_Type_STATUS_Periodic = PeriodicModeBackupPolicy_Type_STATUS("Periodic")
const RestoreParameters_RestoreMode_PointInTime = RestoreParameters_RestoreMode("PointInTime")
const RestoreParameters_RestoreMode_STATUS_PointInTime = RestoreParameters_RestoreMode_STATUS("PointInTime")
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountKeyMetadata_STATUS ¶
type AccountKeyMetadata_STATUS struct {
// GenerationTime: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means
// that the last key regeneration was triggered before 2022-06-18.
GenerationTime *string `json:"generationTime,omitempty"`
}
The metadata related to an access key for a given database account.
type AnalyticalStorageConfiguration ¶
type AnalyticalStorageConfiguration struct {
// SchemaType: Describes the types of schema for analytical storage.
SchemaType *AnalyticalStorageSchemaType `json:"schemaType,omitempty"`
}
Analytical storage specific properties.
type AnalyticalStorageConfiguration_STATUS ¶
type AnalyticalStorageConfiguration_STATUS struct {
// SchemaType: Describes the types of schema for analytical storage.
SchemaType *AnalyticalStorageSchemaType_STATUS `json:"schemaType,omitempty"`
}
Analytical storage specific properties.
type AnalyticalStorageSchemaType ¶
type AnalyticalStorageSchemaType string
Describes the types of schema for analytical storage. +kubebuilder:validation:Enum={"FullFidelity","WellDefined"}
type AnalyticalStorageSchemaType_STATUS ¶
type AnalyticalStorageSchemaType_STATUS string
Describes the types of schema for analytical storage.
type ApiProperties ¶
type ApiProperties struct {
// ServerVersion: Describes the version of the MongoDB account.
ServerVersion *ApiProperties_ServerVersion `json:"serverVersion,omitempty"`
}
type ApiProperties_STATUS ¶
type ApiProperties_STATUS struct {
// ServerVersion: Describes the version of the MongoDB account.
ServerVersion *ApiProperties_ServerVersion_STATUS `json:"serverVersion,omitempty"`
}
type ApiProperties_ServerVersion ¶
type ApiProperties_ServerVersion string
+kubebuilder:validation:Enum={"3.2","3.6","4.0","4.2","5.0","6.0","7.0"}
type ApiProperties_ServerVersion_STATUS ¶
type ApiProperties_ServerVersion_STATUS string
type AutoUpgradePolicyResource ¶
type AutoUpgradePolicyResource struct {
// ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade
ThroughputPolicy *ThroughputPolicyResource `json:"throughputPolicy,omitempty"`
}
Cosmos DB resource auto-upgrade policy
type AutoUpgradePolicyResource_STATUS ¶
type AutoUpgradePolicyResource_STATUS struct {
// ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade
ThroughputPolicy *ThroughputPolicyResource_STATUS `json:"throughputPolicy,omitempty"`
}
Cosmos DB resource auto-upgrade policy
type AutoscaleSettings ¶
type AutoscaleSettings struct {
// MaxThroughput: Represents maximum throughput, the resource can scale up to.
MaxThroughput *int `json:"maxThroughput,omitempty"`
}
type AutoscaleSettingsResource ¶
type AutoscaleSettingsResource struct {
// AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy
AutoUpgradePolicy *AutoUpgradePolicyResource `json:"autoUpgradePolicy,omitempty"`
// MaxThroughput: Represents maximum throughput container can scale up to.
MaxThroughput *int `json:"maxThroughput,omitempty"`
}
Cosmos DB provisioned throughput settings object
type AutoscaleSettingsResource_STATUS ¶
type AutoscaleSettingsResource_STATUS struct {
// AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy
AutoUpgradePolicy *AutoUpgradePolicyResource_STATUS `json:"autoUpgradePolicy,omitempty"`
// MaxThroughput: Represents maximum throughput container can scale up to.
MaxThroughput *int `json:"maxThroughput,omitempty"`
// TargetMaxThroughput: Represents target maximum throughput container can scale up to once offer is no longer in pending
// state.
TargetMaxThroughput *int `json:"targetMaxThroughput,omitempty"`
}
Cosmos DB provisioned throughput settings object
type AutoscaleSettings_STATUS ¶
type AutoscaleSettings_STATUS struct {
// MaxThroughput: Represents maximum throughput, the resource can scale up to.
MaxThroughput *int `json:"maxThroughput,omitempty"`
}
type BackupPolicy ¶
type BackupPolicy struct {
// Continuous: Mutually exclusive with all other properties
Continuous *ContinuousModeBackupPolicy `json:"continuous,omitempty"`
// Periodic: Mutually exclusive with all other properties
Periodic *PeriodicModeBackupPolicy `json:"periodic,omitempty"`
}
func (BackupPolicy) MarshalJSON ¶
func (policy BackupPolicy) MarshalJSON() ([]byte, error)
MarshalJSON defers JSON marshaling to the first non-nil property, because BackupPolicy represents a discriminated union (JSON OneOf)
func (*BackupPolicy) UnmarshalJSON ¶
func (policy *BackupPolicy) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshals the BackupPolicy
type BackupPolicyMigrationState ¶
type BackupPolicyMigrationState struct {
// StartTime: Time at which the backup policy migration started (ISO-8601 format).
StartTime *string `json:"startTime,omitempty"`
// Status: Describes the status of migration between backup policy types.
Status *BackupPolicyMigrationStatus `json:"status,omitempty"`
// TargetType: Describes the target backup policy type of the backup policy migration.
TargetType *BackupPolicyType `json:"targetType,omitempty"`
}
The object representing the state of the migration between the backup policies.
type BackupPolicyMigrationState_STATUS ¶
type BackupPolicyMigrationState_STATUS struct {
// StartTime: Time at which the backup policy migration started (ISO-8601 format).
StartTime *string `json:"startTime,omitempty"`
// Status: Describes the status of migration between backup policy types.
Status *BackupPolicyMigrationStatus_STATUS `json:"status,omitempty"`
// TargetType: Describes the target backup policy type of the backup policy migration.
TargetType *BackupPolicyType_STATUS `json:"targetType,omitempty"`
}
The object representing the state of the migration between the backup policies.
type BackupPolicyMigrationStatus ¶
type BackupPolicyMigrationStatus string
Describes the status of migration between backup policy types. +kubebuilder:validation:Enum={"Completed","Failed","InProgress","Invalid"}
type BackupPolicyMigrationStatus_STATUS ¶
type BackupPolicyMigrationStatus_STATUS string
Describes the status of migration between backup policy types.
type BackupPolicyType ¶
type BackupPolicyType string
Describes the mode of backups. +kubebuilder:validation:Enum={"Continuous","Periodic"}
type BackupPolicy_STATUS ¶
type BackupPolicy_STATUS struct {
// Continuous: Mutually exclusive with all other properties
Continuous *ContinuousModeBackupPolicy_STATUS `json:"continuous,omitempty"`
// Periodic: Mutually exclusive with all other properties
Periodic *PeriodicModeBackupPolicy_STATUS `json:"periodic,omitempty"`
}
func (BackupPolicy_STATUS) MarshalJSON ¶
func (policy BackupPolicy_STATUS) MarshalJSON() ([]byte, error)
MarshalJSON defers JSON marshaling to the first non-nil property, because BackupPolicy_STATUS represents a discriminated union (JSON OneOf)
func (*BackupPolicy_STATUS) UnmarshalJSON ¶
func (policy *BackupPolicy_STATUS) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshals the BackupPolicy_STATUS
type BackupStorageRedundancy ¶
type BackupStorageRedundancy string
Enum to indicate type of backup storage redundancy. +kubebuilder:validation:Enum={"Geo","Local","Zone"}
type BackupStorageRedundancy_STATUS ¶
type BackupStorageRedundancy_STATUS string
Enum to indicate type of backup storage redundancy.
type Capability ¶
type Capability struct {
// Name: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include
// "EnableTable" and "EnableGremlin".
Name *string `json:"name,omitempty"`
}
Cosmos DB capability object
type Capability_STATUS ¶
type Capability_STATUS struct {
// Name: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include
// "EnableTable" and "EnableGremlin".
Name *string `json:"name,omitempty"`
}
Cosmos DB capability object
type Capacity ¶
type Capacity struct {
// TotalThroughputLimit: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict
// limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no
// limits on provisioning of throughput.
TotalThroughputLimit *int `json:"totalThroughputLimit,omitempty"`
}
The object that represents all properties related to capacity enforcement on an account.
type Capacity_STATUS ¶
type Capacity_STATUS struct {
// TotalThroughputLimit: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict
// limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no
// limits on provisioning of throughput.
TotalThroughputLimit *int `json:"totalThroughputLimit,omitempty"`
}
The object that represents all properties related to capacity enforcement on an account.
type ClientEncryptionIncludedPath ¶
type ClientEncryptionIncludedPath struct {
// ClientEncryptionKeyId: The identifier of the Client Encryption Key to be used to encrypt the path.
ClientEncryptionKeyId *string `json:"clientEncryptionKeyId,omitempty"`
// EncryptionAlgorithm: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
EncryptionAlgorithm *string `json:"encryptionAlgorithm,omitempty"`
// EncryptionType: The type of encryption to be performed. Eg - Deterministic, Randomized.
EncryptionType *string `json:"encryptionType,omitempty"`
// Path: Path that needs to be encrypted.
Path *string `json:"path,omitempty"`
}
.
type ClientEncryptionIncludedPath_STATUS ¶
type ClientEncryptionIncludedPath_STATUS struct {
// ClientEncryptionKeyId: The identifier of the Client Encryption Key to be used to encrypt the path.
ClientEncryptionKeyId *string `json:"clientEncryptionKeyId,omitempty"`
// EncryptionAlgorithm: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
EncryptionAlgorithm *string `json:"encryptionAlgorithm,omitempty"`
// EncryptionType: The type of encryption to be performed. Eg - Deterministic, Randomized.
EncryptionType *string `json:"encryptionType,omitempty"`
// Path: Path that needs to be encrypted.
Path *string `json:"path,omitempty"`
}
.
type ClientEncryptionPolicy ¶
type ClientEncryptionPolicy struct {
// IncludedPaths: Paths of the item that need encryption along with path-specific settings.
IncludedPaths []ClientEncryptionIncludedPath `json:"includedPaths,omitempty"`
// PolicyFormatVersion: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2
// supports id and partition key path encryption.
PolicyFormatVersion *int `json:"policyFormatVersion,omitempty"`
}
Cosmos DB client encryption policy.
type ClientEncryptionPolicy_STATUS ¶
type ClientEncryptionPolicy_STATUS struct {
// IncludedPaths: Paths of the item that need encryption along with path-specific settings.
IncludedPaths []ClientEncryptionIncludedPath_STATUS `json:"includedPaths,omitempty"`
// PolicyFormatVersion: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2
// supports id and partition key path encryption.
PolicyFormatVersion *int `json:"policyFormatVersion,omitempty"`
}
Cosmos DB client encryption policy.
type CompositePath ¶
type CompositePath struct {
// Order: Sort order for composite paths.
Order *CompositePath_Order `json:"order,omitempty"`
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
}
type CompositePath_Order ¶
type CompositePath_Order string
+kubebuilder:validation:Enum={"ascending","descending"}
type CompositePath_Order_STATUS ¶
type CompositePath_Order_STATUS string
type CompositePath_STATUS ¶
type CompositePath_STATUS struct {
// Order: Sort order for composite paths.
Order *CompositePath_Order_STATUS `json:"order,omitempty"`
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
}
type ComputedProperty ¶
type ComputedProperty struct {
// Name: The name of a computed property, for example - "cp_lowerName"
Name *string `json:"name,omitempty"`
// Query: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
Query *string `json:"query,omitempty"`
}
The definition of a computed property
type ComputedProperty_STATUS ¶
type ComputedProperty_STATUS struct {
// Name: The name of a computed property, for example - "cp_lowerName"
Name *string `json:"name,omitempty"`
// Query: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
Query *string `json:"query,omitempty"`
}
The definition of a computed property
type ConflictResolutionPolicy ¶
type ConflictResolutionPolicy struct {
// ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode.
ConflictResolutionPath *string `json:"conflictResolutionPath,omitempty"`
// ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode.
ConflictResolutionProcedure *string `json:"conflictResolutionProcedure,omitempty"`
// Mode: Indicates the conflict resolution mode.
Mode *ConflictResolutionPolicy_Mode `json:"mode,omitempty"`
}
The conflict resolution policy for the container.
type ConflictResolutionPolicy_Mode ¶
type ConflictResolutionPolicy_Mode string
+kubebuilder:validation:Enum={"Custom","LastWriterWins"}
type ConflictResolutionPolicy_Mode_STATUS ¶
type ConflictResolutionPolicy_Mode_STATUS string
type ConflictResolutionPolicy_STATUS ¶
type ConflictResolutionPolicy_STATUS struct {
// ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode.
ConflictResolutionPath *string `json:"conflictResolutionPath,omitempty"`
// ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode.
ConflictResolutionProcedure *string `json:"conflictResolutionProcedure,omitempty"`
// Mode: Indicates the conflict resolution mode.
Mode *ConflictResolutionPolicy_Mode_STATUS `json:"mode,omitempty"`
}
The conflict resolution policy for the container.
type ConnectorOffer ¶
type ConnectorOffer string
The cassandra connector offer type for the Cosmos DB C* database account. +kubebuilder:validation:Enum={"Small"}
type ConnectorOffer_STATUS ¶
type ConnectorOffer_STATUS string
The cassandra connector offer type for the Cosmos DB C* database account.
type ConsistencyPolicy ¶
type ConsistencyPolicy struct {
// DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account.
DefaultConsistencyLevel *ConsistencyPolicy_DefaultConsistencyLevel `json:"defaultConsistencyLevel,omitempty"`
// MaxIntervalInSeconds: When used with the Bounded Staleness consistency level, this value represents the time amount of
// staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is
// set to 'BoundedStaleness'.
MaxIntervalInSeconds *int `json:"maxIntervalInSeconds,omitempty"`
// MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale
// requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set
// to 'BoundedStaleness'.
MaxStalenessPrefix *int `json:"maxStalenessPrefix,omitempty"`
}
The consistency policy for the Cosmos DB database account.
type ConsistencyPolicy_DefaultConsistencyLevel ¶
type ConsistencyPolicy_DefaultConsistencyLevel string
+kubebuilder:validation:Enum={"BoundedStaleness","ConsistentPrefix","Eventual","Session","Strong"}
type ConsistencyPolicy_DefaultConsistencyLevel_STATUS ¶
type ConsistencyPolicy_DefaultConsistencyLevel_STATUS string
type ConsistencyPolicy_STATUS ¶
type ConsistencyPolicy_STATUS struct {
// DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account.
DefaultConsistencyLevel *ConsistencyPolicy_DefaultConsistencyLevel_STATUS `json:"defaultConsistencyLevel,omitempty"`
// MaxIntervalInSeconds: When used with the Bounded Staleness consistency level, this value represents the time amount of
// staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is
// set to 'BoundedStaleness'.
MaxIntervalInSeconds *int `json:"maxIntervalInSeconds,omitempty"`
// MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale
// requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set
// to 'BoundedStaleness'.
MaxStalenessPrefix *int `json:"maxStalenessPrefix,omitempty"`
}
The consistency policy for the Cosmos DB database account.
type ContainerPartitionKey ¶
type ContainerPartitionKey struct {
// Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum)
// are supported for container create
Kind *ContainerPartitionKey_Kind `json:"kind,omitempty"`
// Paths: List of paths using which data within the container can be partitioned
Paths []string `json:"paths,omitempty"`
// Version: Indicates the version of the partition key definition
Version *int `json:"version,omitempty"`
}
The configuration of the partition key to be used for partitioning data into multiple partitions
type ContainerPartitionKey_Kind ¶
type ContainerPartitionKey_Kind string
+kubebuilder:validation:Enum={"Hash","MultiHash","Range"}
type ContainerPartitionKey_Kind_STATUS ¶
type ContainerPartitionKey_Kind_STATUS string
type ContainerPartitionKey_STATUS ¶
type ContainerPartitionKey_STATUS struct {
// Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum)
// are supported for container create
Kind *ContainerPartitionKey_Kind_STATUS `json:"kind,omitempty"`
// Paths: List of paths using which data within the container can be partitioned
Paths []string `json:"paths,omitempty"`
// SystemKey: Indicates if the container is using a system generated partition key
SystemKey *bool `json:"systemKey,omitempty"`
// Version: Indicates the version of the partition key definition
Version *int `json:"version,omitempty"`
}
The configuration of the partition key to be used for partitioning data into multiple partitions
type ContinuousModeBackupPolicy ¶
type ContinuousModeBackupPolicy struct {
// ContinuousModeProperties: Configuration values for continuous mode backup
ContinuousModeProperties *ContinuousModeProperties `json:"continuousModeProperties,omitempty"`
// MigrationState: The object representing the state of the migration between the backup policies.
MigrationState *BackupPolicyMigrationState `json:"migrationState,omitempty"`
// Type: Describes the mode of backups.
Type ContinuousModeBackupPolicy_Type `json:"type,omitempty"`
}
type ContinuousModeBackupPolicy_STATUS ¶
type ContinuousModeBackupPolicy_STATUS struct {
// ContinuousModeProperties: Configuration values for continuous mode backup
ContinuousModeProperties *ContinuousModeProperties_STATUS `json:"continuousModeProperties,omitempty"`
// MigrationState: The object representing the state of the migration between the backup policies.
MigrationState *BackupPolicyMigrationState_STATUS `json:"migrationState,omitempty"`
// Type: Describes the mode of backups.
Type ContinuousModeBackupPolicy_Type_STATUS `json:"type,omitempty"`
}
type ContinuousModeBackupPolicy_Type ¶
type ContinuousModeBackupPolicy_Type string
+kubebuilder:validation:Enum={"Continuous"}
type ContinuousModeBackupPolicy_Type_STATUS ¶
type ContinuousModeBackupPolicy_Type_STATUS string
type ContinuousModeProperties ¶
type ContinuousModeProperties struct {
// Tier: Enum to indicate type of Continuous backup mode
Tier *ContinuousTier `json:"tier,omitempty"`
}
Configuration values for periodic mode backup
type ContinuousModeProperties_STATUS ¶
type ContinuousModeProperties_STATUS struct {
// Tier: Enum to indicate type of Continuous backup mode
Tier *ContinuousTier_STATUS `json:"tier,omitempty"`
}
Configuration values for periodic mode backup
type ContinuousTier ¶
type ContinuousTier string
Enum to indicate type of Continuous backup tier. +kubebuilder:validation:Enum={"Continuous30Days","Continuous7Days"}
type ContinuousTier_STATUS ¶
type ContinuousTier_STATUS string
Enum to indicate type of Continuous backup tier.
type CorsPolicy ¶
type CorsPolicy struct {
// AllowedHeaders: The request headers that the origin domain may specify on the CORS request.
AllowedHeaders *string `json:"allowedHeaders,omitempty"`
// AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request.
AllowedMethods *string `json:"allowedMethods,omitempty"`
// AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS.
AllowedOrigins *string `json:"allowedOrigins,omitempty"`
// ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to
// the request issuer.
ExposedHeaders *string `json:"exposedHeaders,omitempty"`
// MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request.
MaxAgeInSeconds *int `json:"maxAgeInSeconds,omitempty"`
}
The CORS policy for the Cosmos DB database account.
type CorsPolicy_STATUS ¶
type CorsPolicy_STATUS struct {
// AllowedHeaders: The request headers that the origin domain may specify on the CORS request.
AllowedHeaders *string `json:"allowedHeaders,omitempty"`
// AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request.
AllowedMethods *string `json:"allowedMethods,omitempty"`
// AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS.
AllowedOrigins *string `json:"allowedOrigins,omitempty"`
// ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to
// the request issuer.
ExposedHeaders *string `json:"exposedHeaders,omitempty"`
// MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request.
MaxAgeInSeconds *int `json:"maxAgeInSeconds,omitempty"`
}
The CORS policy for the Cosmos DB database account.
type CreateMode ¶
type CreateMode string
Enum to indicate the mode of account creation. +kubebuilder:validation:Enum={"Default","Restore"}
type CreateMode_STATUS ¶
type CreateMode_STATUS string
Enum to indicate the mode of account creation.
type CreateUpdateOptions ¶
type CreateUpdateOptions struct {
// AutoscaleSettings: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not
// both.
AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
// Throughput: Request Units per second. For example, "throughput": 10000.
Throughput *int `json:"throughput,omitempty"`
}
CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"
type DatabaseAccountCreateUpdateProperties ¶
type DatabaseAccountCreateUpdateProperties struct {
// AnalyticalStorageConfiguration: Analytical storage specific properties.
AnalyticalStorageConfiguration *AnalyticalStorageConfiguration `json:"analyticalStorageConfiguration,omitempty"`
// ApiProperties: API specific properties. Currently, supported only for MongoDB API.
ApiProperties *ApiProperties `json:"apiProperties,omitempty"`
// BackupPolicy: The object representing the policy for taking backups on an account.
BackupPolicy *BackupPolicy `json:"backupPolicy,omitempty"`
// Capabilities: List of Cosmos DB capabilities for the account
Capabilities []Capability `json:"capabilities,omitempty"`
// Capacity: The object that represents all properties related to capacity enforcement on an account.
Capacity *Capacity `json:"capacity,omitempty"`
// ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account.
ConnectorOffer *ConnectorOffer `json:"connectorOffer,omitempty"`
// ConsistencyPolicy: The consistency policy for the Cosmos DB account.
ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"`
// Cors: The CORS policy for the Cosmos DB database account.
Cors []CorsPolicy `json:"cors,omitempty"`
// CreateMode: Enum to indicate the mode of account creation.
CreateMode *CreateMode `json:"createMode,omitempty"`
// CustomerManagedKeyStatus: Indicates the status of the Customer Managed Key feature on the account. In case there are
// errors, the property provides troubleshooting guidance.
CustomerManagedKeyStatus *string `json:"customerManagedKeyStatus,omitempty"`
// DatabaseAccountOfferType: The offer type for the database
DatabaseAccountOfferType *DatabaseAccountOfferType `json:"databaseAccountOfferType,omitempty"`
// DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default
// identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DefaultIdentity *string `json:"defaultIdentity,omitempty"`
// DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput)
// via account keys
DisableKeyBasedMetadataWriteAccess *bool `json:"disableKeyBasedMetadataWriteAccess,omitempty"`
// DisableLocalAuth: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`
// EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics.
EnableAnalyticalStorage *bool `json:"enableAnalyticalStorage,omitempty"`
// EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable
// due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the
// failover priorities configured for the account.
EnableAutomaticFailover *bool `json:"enableAutomaticFailover,omitempty"`
// EnableBurstCapacity: Flag to indicate enabling/disabling of Burst Capacity feature on the account
EnableBurstCapacity *bool `json:"enableBurstCapacity,omitempty"`
// EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account
EnableCassandraConnector *bool `json:"enableCassandraConnector,omitempty"`
// EnableFreeTier: Flag to indicate whether Free Tier is enabled.
EnableFreeTier *bool `json:"enableFreeTier,omitempty"`
// EnableMultipleWriteLocations: Enables the account to write in multiple locations
EnableMultipleWriteLocations *bool `json:"enableMultipleWriteLocations,omitempty"`
// EnablePartitionMerge: Flag to indicate enabling/disabling of Partition Merge feature on the account
EnablePartitionMerge *bool `json:"enablePartitionMerge,omitempty"`
// IpRules: List of IpRules.
IpRules []IpAddressOrRange `json:"ipRules,omitempty"`
// IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules.
IsVirtualNetworkFilterEnabled *bool `json:"isVirtualNetworkFilterEnabled,omitempty"`
// KeyVaultKeyUri: The URI of the key vault
KeyVaultKeyUri *string `json:"keyVaultKeyUri,omitempty"`
// Locations: An array that contains the georeplication locations enabled for the Cosmos DB account.
Locations []Location `json:"locations,omitempty"`
// MinimalTlsVersion: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs
// only work with Tls 1.2.
MinimalTlsVersion *MinimalTlsVersion `json:"minimalTlsVersion,omitempty"`
// NetworkAclBypass: Indicates what services are allowed to bypass firewall checks.
NetworkAclBypass *NetworkAclBypass `json:"networkAclBypass,omitempty"`
NetworkAclBypassResourceIds []string `json:"networkAclBypassResourceIds,omitempty"`
// PublicNetworkAccess: Whether requests from Public Network are allowed
PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore.
RestoreParameters *RestoreParameters `json:"restoreParameters,omitempty"`
// VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.
VirtualNetworkRules []VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
}
Properties to create and update Azure Cosmos DB database accounts.
type DatabaseAccountGetProperties_STATUS ¶
type DatabaseAccountGetProperties_STATUS struct {
// AnalyticalStorageConfiguration: Analytical storage specific properties.
AnalyticalStorageConfiguration *AnalyticalStorageConfiguration_STATUS `json:"analyticalStorageConfiguration,omitempty"`
// ApiProperties: API specific properties.
ApiProperties *ApiProperties_STATUS `json:"apiProperties,omitempty"`
// BackupPolicy: The object representing the policy for taking backups on an account.
BackupPolicy *BackupPolicy_STATUS `json:"backupPolicy,omitempty"`
// Capabilities: List of Cosmos DB capabilities for the account
Capabilities []Capability_STATUS `json:"capabilities,omitempty"`
// Capacity: The object that represents all properties related to capacity enforcement on an account.
Capacity *Capacity_STATUS `json:"capacity,omitempty"`
// ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account.
ConnectorOffer *ConnectorOffer_STATUS `json:"connectorOffer,omitempty"`
// ConsistencyPolicy: The consistency policy for the Cosmos DB database account.
ConsistencyPolicy *ConsistencyPolicy_STATUS `json:"consistencyPolicy,omitempty"`
// Cors: The CORS policy for the Cosmos DB database account.
Cors []CorsPolicy_STATUS `json:"cors,omitempty"`
// CreateMode: Enum to indicate the mode of account creation.
CreateMode *CreateMode_STATUS `json:"createMode,omitempty"`
// CustomerManagedKeyStatus: Indicates the status of the Customer Managed Key feature on the account. In case there are
// errors, the property provides troubleshooting guidance.
CustomerManagedKeyStatus *string `json:"customerManagedKeyStatus,omitempty"`
// DatabaseAccountOfferType: The offer type for the Cosmos DB database account. Default value: Standard.
DatabaseAccountOfferType *DatabaseAccountOfferType_STATUS `json:"databaseAccountOfferType,omitempty"`
// DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default
// identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DefaultIdentity *string `json:"defaultIdentity,omitempty"`
// DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput)
// via account keys
DisableKeyBasedMetadataWriteAccess *bool `json:"disableKeyBasedMetadataWriteAccess,omitempty"`
// DisableLocalAuth: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`
// DocumentEndpoint: The connection endpoint for the Cosmos DB database account.
DocumentEndpoint *string `json:"documentEndpoint,omitempty"`
// EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics.
EnableAnalyticalStorage *bool `json:"enableAnalyticalStorage,omitempty"`
// EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable
// due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the
// failover priorities configured for the account.
EnableAutomaticFailover *bool `json:"enableAutomaticFailover,omitempty"`
// EnableBurstCapacity: Flag to indicate enabling/disabling of Burst Capacity feature on the account
EnableBurstCapacity *bool `json:"enableBurstCapacity,omitempty"`
// EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account
EnableCassandraConnector *bool `json:"enableCassandraConnector,omitempty"`
// EnableFreeTier: Flag to indicate whether Free Tier is enabled.
EnableFreeTier *bool `json:"enableFreeTier,omitempty"`
// EnableMultipleWriteLocations: Enables the account to write in multiple locations
EnableMultipleWriteLocations *bool `json:"enableMultipleWriteLocations,omitempty"`
// EnablePartitionMerge: Flag to indicate enabling/disabling of Partition Merge feature on the account
EnablePartitionMerge *bool `json:"enablePartitionMerge,omitempty"`
// FailoverPolicies: An array that contains the regions ordered by their failover priorities.
FailoverPolicies []FailoverPolicy_STATUS `json:"failoverPolicies,omitempty"`
// InstanceId: A unique identifier assigned to the database account
InstanceId *string `json:"instanceId,omitempty"`
// IpRules: List of IpRules.
IpRules []IpAddressOrRange_STATUS `json:"ipRules,omitempty"`
// IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules.
IsVirtualNetworkFilterEnabled *bool `json:"isVirtualNetworkFilterEnabled,omitempty"`
// KeyVaultKeyUri: The URI of the key vault
KeyVaultKeyUri *string `json:"keyVaultKeyUri,omitempty"`
// KeysMetadata: The object that represents the metadata for the Account Keys of the Cosmos DB account.
KeysMetadata *DatabaseAccountKeysMetadata_STATUS `json:"keysMetadata,omitempty"`
// Locations: An array that contains all of the locations enabled for the Cosmos DB account.
Locations []Location_STATUS `json:"locations,omitempty"`
// MinimalTlsVersion: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs
// only work with Tls 1.2.
MinimalTlsVersion *MinimalTlsVersion_STATUS `json:"minimalTlsVersion,omitempty"`
// NetworkAclBypass: Indicates what services are allowed to bypass firewall checks.
NetworkAclBypass *NetworkAclBypass_STATUS `json:"networkAclBypass,omitempty"`
// NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
NetworkAclBypassResourceIds []string `json:"networkAclBypassResourceIds,omitempty"`
// PrivateEndpointConnections: List of Private Endpoint Connections configured for the Cosmos DB account.
PrivateEndpointConnections []PrivateEndpointConnection_STATUS `json:"privateEndpointConnections,omitempty"`
ProvisioningState *string `json:"provisioningState,omitempty"`
// PublicNetworkAccess: Whether requests from Public Network are allowed
PublicNetworkAccess *PublicNetworkAccess_STATUS `json:"publicNetworkAccess,omitempty"`
// ReadLocations: An array that contains of the read locations enabled for the Cosmos DB account.
ReadLocations []Location_STATUS `json:"readLocations,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore.
RestoreParameters *RestoreParameters_STATUS `json:"restoreParameters,omitempty"`
// VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.
VirtualNetworkRules []VirtualNetworkRule_STATUS `json:"virtualNetworkRules,omitempty"`
// WriteLocations: An array that contains the write location for the Cosmos DB account.
WriteLocations []Location_STATUS `json:"writeLocations,omitempty"`
}
Properties for the database account.
type DatabaseAccountKeysMetadata_STATUS ¶
type DatabaseAccountKeysMetadata_STATUS struct {
// PrimaryMasterKey: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
PrimaryMasterKey *AccountKeyMetadata_STATUS `json:"primaryMasterKey,omitempty"`
// PrimaryReadonlyMasterKey: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
PrimaryReadonlyMasterKey *AccountKeyMetadata_STATUS `json:"primaryReadonlyMasterKey,omitempty"`
// SecondaryMasterKey: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
SecondaryMasterKey *AccountKeyMetadata_STATUS `json:"secondaryMasterKey,omitempty"`
// SecondaryReadonlyMasterKey: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.
SecondaryReadonlyMasterKey *AccountKeyMetadata_STATUS `json:"secondaryReadonlyMasterKey,omitempty"`
}
The metadata related to each access key for the given Cosmos DB database account.
type DatabaseAccountOfferType ¶
type DatabaseAccountOfferType string
The offer type for the Cosmos DB database account. +kubebuilder:validation:Enum={"Standard"}
type DatabaseAccountOfferType_STATUS ¶
type DatabaseAccountOfferType_STATUS string
The offer type for the Cosmos DB database account.
type DatabaseAccount_Kind_STATUS ¶
type DatabaseAccount_Kind_STATUS string
type DatabaseAccount_Kind_Spec ¶
type DatabaseAccount_Kind_Spec string
+kubebuilder:validation:Enum={"GlobalDocumentDB","MongoDB","Parse"}
type DatabaseAccount_STATUS ¶
type DatabaseAccount_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Identity: Identity for the resource.
Identity *ManagedServiceIdentity_STATUS `json:"identity,omitempty"`
// Kind: Indicates the type of database account. This can only be set at database account creation.
Kind *DatabaseAccount_Kind_STATUS `json:"kind,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: Properties for the database account.
Properties *DatabaseAccountGetProperties_STATUS `json:"properties,omitempty"`
// SystemData: The system meta data relating to this resource.
SystemData *SystemData_STATUS `json:"systemData,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type DatabaseAccount_Spec ¶
type DatabaseAccount_Spec struct {
// Identity: Identity for the resource.
Identity *ManagedServiceIdentity `json:"identity,omitempty"`
// Kind: Indicates the type of database account. This can only be set at database account creation.
Kind *DatabaseAccount_Kind_Spec `json:"kind,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB database accounts.
Properties *DatabaseAccountCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (DatabaseAccount_Spec) GetAPIVersion ¶
func (account DatabaseAccount_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*DatabaseAccount_Spec) GetName ¶
func (account *DatabaseAccount_Spec) GetName() string
GetName returns the Name of the resource
func (*DatabaseAccount_Spec) GetType ¶
func (account *DatabaseAccount_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts"
type DatabaseRestoreResource ¶
type DatabaseRestoreResource struct {
// CollectionNames: The names of the collections available for restore.
CollectionNames []string `json:"collectionNames,omitempty"`
// DatabaseName: The name of the database available for restore.
DatabaseName *string `json:"databaseName,omitempty"`
}
Specific Databases to restore.
type DatabaseRestoreResource_STATUS ¶
type DatabaseRestoreResource_STATUS struct {
// CollectionNames: The names of the collections available for restore.
CollectionNames []string `json:"collectionNames,omitempty"`
// DatabaseName: The name of the database available for restore.
DatabaseName *string `json:"databaseName,omitempty"`
}
Specific Databases to restore.
type ExcludedPath ¶
type ExcludedPath struct {
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
}
type ExcludedPath_STATUS ¶
type ExcludedPath_STATUS struct {
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
}
type FailoverPolicy_STATUS ¶
type FailoverPolicy_STATUS struct {
// FailoverPriority: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum
// value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the
// regions in which the database account exists.
FailoverPriority *int `json:"failoverPriority,omitempty"`
// Id: The unique identifier of the region in which the database account replicates to. Example:
// <accountName>-<locationName>.
Id *string `json:"id,omitempty"`
// LocationName: The name of the region in which the database account exists.
LocationName *string `json:"locationName,omitempty"`
}
The failover policy for a given region of a database account.
type GremlinDatabaseRestoreResource ¶
type GremlinDatabaseRestoreResource struct {
// DatabaseName: The name of the gremlin database available for restore.
DatabaseName *string `json:"databaseName,omitempty"`
// GraphNames: The names of the graphs available for restore.
GraphNames []string `json:"graphNames,omitempty"`
}
Specific Gremlin Databases to restore.
type GremlinDatabaseRestoreResource_STATUS ¶
type GremlinDatabaseRestoreResource_STATUS struct {
// DatabaseName: The name of the gremlin database available for restore.
DatabaseName *string `json:"databaseName,omitempty"`
// GraphNames: The names of the graphs available for restore.
GraphNames []string `json:"graphNames,omitempty"`
}
Specific Gremlin Databases to restore.
type IncludedPath ¶
type IncludedPath struct {
// Indexes: List of indexes for this path
Indexes []Indexes `json:"indexes,omitempty"`
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
}
The paths that are included in indexing
type IncludedPath_STATUS ¶
type IncludedPath_STATUS struct {
// Indexes: List of indexes for this path
Indexes []Indexes_STATUS `json:"indexes,omitempty"`
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
}
The paths that are included in indexing
type Indexes ¶
type Indexes struct {
// DataType: The datatype for which the indexing behavior is applied to.
DataType *Indexes_DataType `json:"dataType,omitempty"`
// Kind: Indicates the type of index.
Kind *Indexes_Kind `json:"kind,omitempty"`
// Precision: The precision of the index. -1 is maximum precision.
Precision *int `json:"precision,omitempty"`
}
The indexes for the path.
type Indexes_DataType ¶
type Indexes_DataType string
+kubebuilder:validation:Enum={"LineString","MultiPolygon","Number","Point","Polygon","String"}
type Indexes_DataType_STATUS ¶
type Indexes_DataType_STATUS string
type Indexes_Kind ¶
type Indexes_Kind string
+kubebuilder:validation:Enum={"Hash","Range","Spatial"}
type Indexes_Kind_STATUS ¶
type Indexes_Kind_STATUS string
type Indexes_STATUS ¶
type Indexes_STATUS struct {
// DataType: The datatype for which the indexing behavior is applied to.
DataType *Indexes_DataType_STATUS `json:"dataType,omitempty"`
// Kind: Indicates the type of index.
Kind *Indexes_Kind_STATUS `json:"kind,omitempty"`
// Precision: The precision of the index. -1 is maximum precision.
Precision *int `json:"precision,omitempty"`
}
The indexes for the path.
type IndexingPolicy ¶
type IndexingPolicy struct {
// Automatic: Indicates if the indexing policy is automatic
Automatic *bool `json:"automatic,omitempty"`
// CompositeIndexes: List of composite path list
CompositeIndexes [][]CompositePath `json:"compositeIndexes,omitempty"`
// ExcludedPaths: List of paths to exclude from indexing
ExcludedPaths []ExcludedPath `json:"excludedPaths,omitempty"`
// IncludedPaths: List of paths to include in the indexing
IncludedPaths []IncludedPath `json:"includedPaths,omitempty"`
// IndexingMode: Indicates the indexing mode.
IndexingMode *IndexingPolicy_IndexingMode `json:"indexingMode,omitempty"`
// SpatialIndexes: List of spatial specifics
SpatialIndexes []SpatialSpec `json:"spatialIndexes,omitempty"`
}
Cosmos DB indexing policy
type IndexingPolicy_IndexingMode ¶
type IndexingPolicy_IndexingMode string
+kubebuilder:validation:Enum={"consistent","lazy","none"}
type IndexingPolicy_IndexingMode_STATUS ¶
type IndexingPolicy_IndexingMode_STATUS string
type IndexingPolicy_STATUS ¶
type IndexingPolicy_STATUS struct {
// Automatic: Indicates if the indexing policy is automatic
Automatic *bool `json:"automatic,omitempty"`
// CompositeIndexes: List of composite path list
CompositeIndexes [][]CompositePath_STATUS `json:"compositeIndexes,omitempty"`
// ExcludedPaths: List of paths to exclude from indexing
ExcludedPaths []ExcludedPath_STATUS `json:"excludedPaths,omitempty"`
// IncludedPaths: List of paths to include in the indexing
IncludedPaths []IncludedPath_STATUS `json:"includedPaths,omitempty"`
// IndexingMode: Indicates the indexing mode.
IndexingMode *IndexingPolicy_IndexingMode_STATUS `json:"indexingMode,omitempty"`
// SpatialIndexes: List of spatial specifics
SpatialIndexes []SpatialSpec_STATUS `json:"spatialIndexes,omitempty"`
}
Cosmos DB indexing policy
type IpAddressOrRange ¶
type IpAddressOrRange struct {
// IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be
// well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12,
// 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245”
// or “23.40.210.0/8”.
IpAddressOrRange *string `json:"ipAddressOrRange,omitempty"`
}
IpAddressOrRange object
type IpAddressOrRange_STATUS ¶
type IpAddressOrRange_STATUS struct {
// IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be
// well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12,
// 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245”
// or “23.40.210.0/8”.
IpAddressOrRange *string `json:"ipAddressOrRange,omitempty"`
}
IpAddressOrRange object
type Location ¶
type Location struct {
// FailoverPriority: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum
// value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the
// regions in which the database account exists.
FailoverPriority *int `json:"failoverPriority,omitempty"`
// IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region
IsZoneRedundant *bool `json:"isZoneRedundant,omitempty"`
// LocationName: The name of the region.
LocationName *string `json:"locationName,omitempty"`
}
A region in which the Azure Cosmos DB database account is deployed.
type Location_STATUS ¶
type Location_STATUS struct {
// DocumentEndpoint: The connection endpoint for the specific region. Example:
// https://<accountName>-<locationName>.documents.azure.com:443/
DocumentEndpoint *string `json:"documentEndpoint,omitempty"`
// FailoverPriority: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum
// value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the
// regions in which the database account exists.
FailoverPriority *int `json:"failoverPriority,omitempty"`
// Id: The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
Id *string `json:"id,omitempty"`
// IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region
IsZoneRedundant *bool `json:"isZoneRedundant,omitempty"`
// LocationName: The name of the region.
LocationName *string `json:"locationName,omitempty"`
ProvisioningState *string `json:"provisioningState,omitempty"`
}
A region in which the Azure Cosmos DB database account is deployed.
type ManagedServiceIdentity ¶
type ManagedServiceIdentity struct {
// Type: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly
// created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
Type *ManagedServiceIdentity_Type `json:"type,omitempty"`
UserAssignedIdentities map[string]UserAssignedIdentityDetails `json:"userAssignedIdentities,omitempty"`
}
Identity for the resource.
type ManagedServiceIdentity_STATUS ¶
type ManagedServiceIdentity_STATUS struct {
// PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned
// identity.
PrincipalId *string `json:"principalId,omitempty"`
// TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned
// identity.
TenantId *string `json:"tenantId,omitempty"`
// Type: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly
// created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
Type *ManagedServiceIdentity_Type_STATUS `json:"type,omitempty"`
// UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key
// references will be ARM resource ids in the form:
// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
UserAssignedIdentities map[string]ManagedServiceIdentity_UserAssignedIdentities_STATUS `json:"userAssignedIdentities,omitempty"`
}
Identity for the resource.
type ManagedServiceIdentity_Type ¶
type ManagedServiceIdentity_Type string
+kubebuilder:validation:Enum={"None","SystemAssigned","SystemAssigned,UserAssigned","UserAssigned"}
type ManagedServiceIdentity_Type_STATUS ¶
type ManagedServiceIdentity_Type_STATUS string
type MinimalTlsVersion ¶
type MinimalTlsVersion string
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. +kubebuilder:validation:Enum={"Tls","Tls11","Tls12"}
type MinimalTlsVersion_STATUS ¶
type MinimalTlsVersion_STATUS string
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
type MongoDBCollectionCreateUpdateProperties ¶
type MongoDBCollectionCreateUpdateProperties struct {
// Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the
// request.
Options *CreateUpdateOptions `json:"options,omitempty"`
// Resource: The standard JSON format of a MongoDB collection
Resource *MongoDBCollectionResource `json:"resource,omitempty"`
}
Properties to create and update Azure Cosmos DB MongoDB collection.
type MongoDBCollectionGetProperties_Resource_STATUS ¶
type MongoDBCollectionGetProperties_Resource_STATUS struct {
// AnalyticalStorageTtl: Analytical TTL.
AnalyticalStorageTtl *int `json:"analyticalStorageTtl,omitempty"`
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode_STATUS `json:"createMode,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// Id: Name of the Cosmos DB MongoDB collection
Id *string `json:"id,omitempty"`
// Indexes: List of index keys
Indexes []MongoIndex_STATUS `json:"indexes,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase_STATUS `json:"restoreParameters,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// ShardKey: A key-value pair of shard keys to be applied for the request.
ShardKey map[string]string `json:"shardKey,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
}
type MongoDBCollectionGetProperties_STATUS ¶
type MongoDBCollectionGetProperties_STATUS struct {
// Options: Cosmos DB options resource object
Options *OptionsResource_STATUS `json:"options,omitempty"`
Resource *MongoDBCollectionGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB MongoDB collection
type MongoDBCollectionResource ¶
type MongoDBCollectionResource struct {
// AnalyticalStorageTtl: Analytical TTL.
AnalyticalStorageTtl *int `json:"analyticalStorageTtl,omitempty"`
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode `json:"createMode,omitempty"`
// Id: Name of the Cosmos DB MongoDB collection
Id *string `json:"id,omitempty"`
// Indexes: List of index keys
Indexes []MongoIndex `json:"indexes,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase `json:"restoreParameters,omitempty"`
// ShardKey: A key-value pair of shard keys to be applied for the request.
ShardKey map[string]string `json:"shardKey,omitempty"`
}
Cosmos DB MongoDB collection resource object
type MongoDBDatabaseCreateUpdateProperties ¶
type MongoDBDatabaseCreateUpdateProperties struct {
// Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the
// request.
Options *CreateUpdateOptions `json:"options,omitempty"`
// Resource: The standard JSON format of a MongoDB database
Resource *MongoDBDatabaseResource `json:"resource,omitempty"`
}
Properties to create and update Azure Cosmos DB MongoDB database.
type MongoDBDatabaseGetProperties_Resource_STATUS ¶
type MongoDBDatabaseGetProperties_Resource_STATUS struct {
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode_STATUS `json:"createMode,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// Id: Name of the Cosmos DB MongoDB database
Id *string `json:"id,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase_STATUS `json:"restoreParameters,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
}
type MongoDBDatabaseGetProperties_STATUS ¶
type MongoDBDatabaseGetProperties_STATUS struct {
// Options: Cosmos DB options resource object
Options *OptionsResource_STATUS `json:"options,omitempty"`
Resource *MongoDBDatabaseGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB MongoDB database
type MongoDBDatabaseResource ¶
type MongoDBDatabaseResource struct {
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode `json:"createMode,omitempty"`
// Id: Name of the Cosmos DB MongoDB database
Id *string `json:"id,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase `json:"restoreParameters,omitempty"`
}
Cosmos DB MongoDB database resource object
type MongoIndex ¶
type MongoIndex struct {
// Key: Cosmos DB MongoDB collection index keys
Key *MongoIndexKeys `json:"key,omitempty"`
// Options: Cosmos DB MongoDB collection index key options
Options *MongoIndexOptions `json:"options,omitempty"`
}
Cosmos DB MongoDB collection index key
type MongoIndexKeys ¶
type MongoIndexKeys struct {
// Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service
Keys []string `json:"keys,omitempty"`
}
Cosmos DB MongoDB collection resource object
type MongoIndexKeys_STATUS ¶
type MongoIndexKeys_STATUS struct {
// Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service
Keys []string `json:"keys,omitempty"`
}
Cosmos DB MongoDB collection resource object
type MongoIndexOptions ¶
type MongoIndexOptions struct {
// ExpireAfterSeconds: Expire after seconds
ExpireAfterSeconds *int `json:"expireAfterSeconds,omitempty"`
// Unique: Is unique or not
Unique *bool `json:"unique,omitempty"`
}
Cosmos DB MongoDB collection index options
type MongoIndexOptions_STATUS ¶
type MongoIndexOptions_STATUS struct {
// ExpireAfterSeconds: Expire after seconds
ExpireAfterSeconds *int `json:"expireAfterSeconds,omitempty"`
// Unique: Is unique or not
Unique *bool `json:"unique,omitempty"`
}
Cosmos DB MongoDB collection index options
type MongoIndex_STATUS ¶
type MongoIndex_STATUS struct {
// Key: Cosmos DB MongoDB collection index keys
Key *MongoIndexKeys_STATUS `json:"key,omitempty"`
// Options: Cosmos DB MongoDB collection index key options
Options *MongoIndexOptions_STATUS `json:"options,omitempty"`
}
Cosmos DB MongoDB collection index key
type MongoUserDefinitionResource ¶
type MongoUserDefinitionResource struct {
// CustomData: A custom definition for the USer Definition.
CustomData *string `json:"customData,omitempty"`
// DatabaseName: The database name for which access is being granted for this User Definition.
DatabaseName *string `json:"databaseName,omitempty"`
// Mechanisms: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
Mechanisms *string `json:"mechanisms,omitempty"`
// Password: The password for User Definition. Response does not contain user password.
Password *string `json:"password,omitempty"`
// Roles: The set of roles inherited by the User Definition.
Roles []Role `json:"roles,omitempty"`
// UserName: The user name for User Definition.
UserName *string `json:"userName,omitempty"`
}
Azure Cosmos DB Mongo User Definition resource object.
type MongoUserDefinitionResource_STATUS ¶
type MongoUserDefinitionResource_STATUS struct {
// CustomData: A custom definition for the USer Definition.
CustomData *string `json:"customData,omitempty"`
// DatabaseName: The database name for which access is being granted for this User Definition.
DatabaseName *string `json:"databaseName,omitempty"`
// Mechanisms: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
Mechanisms *string `json:"mechanisms,omitempty"`
// Roles: The set of roles inherited by the User Definition.
Roles []Role_STATUS `json:"roles,omitempty"`
// UserName: The user name for User Definition.
UserName *string `json:"userName,omitempty"`
}
Azure Cosmos DB Mongo User Definition resource object.
type MongodbDatabaseCollectionThroughputSetting_STATUS ¶
type MongodbDatabaseCollectionThroughputSetting_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB resource throughput
Properties *ThroughputSettingsGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type MongodbDatabaseCollectionThroughputSetting_Spec ¶
type MongodbDatabaseCollectionThroughputSetting_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to update Azure Cosmos DB resource throughput.
Properties *ThroughputSettingsUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (MongodbDatabaseCollectionThroughputSetting_Spec) GetAPIVersion ¶
func (setting MongodbDatabaseCollectionThroughputSetting_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*MongodbDatabaseCollectionThroughputSetting_Spec) GetName ¶
func (setting *MongodbDatabaseCollectionThroughputSetting_Spec) GetName() string
GetName returns the Name of the resource
func (*MongodbDatabaseCollectionThroughputSetting_Spec) GetType ¶
func (setting *MongodbDatabaseCollectionThroughputSetting_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings"
type MongodbDatabaseCollection_STATUS ¶
type MongodbDatabaseCollection_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB MongoDB collection
Properties *MongoDBCollectionGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type MongodbDatabaseCollection_Spec ¶
type MongodbDatabaseCollection_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB MongoDB collection.
Properties *MongoDBCollectionCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (MongodbDatabaseCollection_Spec) GetAPIVersion ¶
func (collection MongodbDatabaseCollection_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*MongodbDatabaseCollection_Spec) GetName ¶
func (collection *MongodbDatabaseCollection_Spec) GetName() string
GetName returns the Name of the resource
func (*MongodbDatabaseCollection_Spec) GetType ¶
func (collection *MongodbDatabaseCollection_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
type MongodbDatabaseThroughputSetting_STATUS ¶
type MongodbDatabaseThroughputSetting_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB resource throughput
Properties *ThroughputSettingsGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type MongodbDatabaseThroughputSetting_Spec ¶
type MongodbDatabaseThroughputSetting_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to update Azure Cosmos DB resource throughput.
Properties *ThroughputSettingsUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (MongodbDatabaseThroughputSetting_Spec) GetAPIVersion ¶
func (setting MongodbDatabaseThroughputSetting_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*MongodbDatabaseThroughputSetting_Spec) GetName ¶
func (setting *MongodbDatabaseThroughputSetting_Spec) GetName() string
GetName returns the Name of the resource
func (*MongodbDatabaseThroughputSetting_Spec) GetType ¶
func (setting *MongodbDatabaseThroughputSetting_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings"
type MongodbDatabase_STATUS ¶
type MongodbDatabase_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB MongoDB database
Properties *MongoDBDatabaseGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type MongodbDatabase_Spec ¶
type MongodbDatabase_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB MongoDB database.
Properties *MongoDBDatabaseCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (MongodbDatabase_Spec) GetAPIVersion ¶
func (database MongodbDatabase_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*MongodbDatabase_Spec) GetName ¶
func (database *MongodbDatabase_Spec) GetName() string
GetName returns the Name of the resource
func (*MongodbDatabase_Spec) GetType ¶
func (database *MongodbDatabase_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases"
type MongodbUserDefinition_STATUS ¶
type MongodbUserDefinition_STATUS struct {
// Id: The unique resource identifier of the database account.
Id *string `json:"id,omitempty"`
// Name: The name of the database account.
Name *string `json:"name,omitempty"`
// Properties: Properties related to the User Definition.
Properties *MongoUserDefinitionResource_STATUS `json:"properties,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type MongodbUserDefinition_Spec ¶
type MongodbUserDefinition_Spec struct {
Name string `json:"name,omitempty"`
// Properties: Properties to create and update an Azure Cosmos DB Mongo User Definition.
Properties *MongoUserDefinitionResource `json:"properties,omitempty"`
}
func (MongodbUserDefinition_Spec) GetAPIVersion ¶
func (definition MongodbUserDefinition_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*MongodbUserDefinition_Spec) GetName ¶
func (definition *MongodbUserDefinition_Spec) GetName() string
GetName returns the Name of the resource
func (*MongodbUserDefinition_Spec) GetType ¶
func (definition *MongodbUserDefinition_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions"
type NetworkAclBypass ¶
type NetworkAclBypass string
Indicates what services are allowed to bypass firewall checks. +kubebuilder:validation:Enum={"AzureServices","None"}
type NetworkAclBypass_STATUS ¶
type NetworkAclBypass_STATUS string
Indicates what services are allowed to bypass firewall checks.
type OptionsResource_STATUS ¶
type OptionsResource_STATUS struct {
// AutoscaleSettings: Specifies the Autoscale settings.
AutoscaleSettings *AutoscaleSettings_STATUS `json:"autoscaleSettings,omitempty"`
// Throughput: Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when
// retrieving offer details.
Throughput *int `json:"throughput,omitempty"`
}
Cosmos DB options resource object
type PeriodicModeBackupPolicy ¶
type PeriodicModeBackupPolicy struct {
// MigrationState: The object representing the state of the migration between the backup policies.
MigrationState *BackupPolicyMigrationState `json:"migrationState,omitempty"`
// PeriodicModeProperties: Configuration values for periodic mode backup
PeriodicModeProperties *PeriodicModeProperties `json:"periodicModeProperties,omitempty"`
// Type: Describes the mode of backups.
Type PeriodicModeBackupPolicy_Type `json:"type,omitempty"`
}
type PeriodicModeBackupPolicy_STATUS ¶
type PeriodicModeBackupPolicy_STATUS struct {
// MigrationState: The object representing the state of the migration between the backup policies.
MigrationState *BackupPolicyMigrationState_STATUS `json:"migrationState,omitempty"`
// PeriodicModeProperties: Configuration values for periodic mode backup
PeriodicModeProperties *PeriodicModeProperties_STATUS `json:"periodicModeProperties,omitempty"`
// Type: Describes the mode of backups.
Type PeriodicModeBackupPolicy_Type_STATUS `json:"type,omitempty"`
}
type PeriodicModeBackupPolicy_Type ¶
type PeriodicModeBackupPolicy_Type string
+kubebuilder:validation:Enum={"Periodic"}
type PeriodicModeBackupPolicy_Type_STATUS ¶
type PeriodicModeBackupPolicy_Type_STATUS string
type PeriodicModeProperties ¶
type PeriodicModeProperties struct {
// BackupIntervalInMinutes: An integer representing the interval in minutes between two backups
BackupIntervalInMinutes *int `json:"backupIntervalInMinutes,omitempty"`
// BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained
BackupRetentionIntervalInHours *int `json:"backupRetentionIntervalInHours,omitempty"`
// BackupStorageRedundancy: Enum to indicate type of backup residency
BackupStorageRedundancy *BackupStorageRedundancy `json:"backupStorageRedundancy,omitempty"`
}
Configuration values for periodic mode backup
type PeriodicModeProperties_STATUS ¶
type PeriodicModeProperties_STATUS struct {
// BackupIntervalInMinutes: An integer representing the interval in minutes between two backups
BackupIntervalInMinutes *int `json:"backupIntervalInMinutes,omitempty"`
// BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained
BackupRetentionIntervalInHours *int `json:"backupRetentionIntervalInHours,omitempty"`
// BackupStorageRedundancy: Enum to indicate type of backup residency
BackupStorageRedundancy *BackupStorageRedundancy_STATUS `json:"backupStorageRedundancy,omitempty"`
}
Configuration values for periodic mode backup
type PrivateEndpointConnection_STATUS ¶
type PrivateEndpointConnection_STATUS struct {
// Id: Fully qualified resource ID for the resource. Ex -
// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Id *string `json:"id,omitempty"`
}
A private endpoint connection
type PublicNetworkAccess ¶
type PublicNetworkAccess string
Whether requests from Public Network are allowed +kubebuilder:validation:Enum={"Disabled","Enabled","SecuredByPerimeter"}
type PublicNetworkAccess_STATUS ¶
type PublicNetworkAccess_STATUS string
Whether requests from Public Network are allowed
type RestoreParameters ¶
type RestoreParameters struct {
// DatabasesToRestore: List of specific databases available for restore.
DatabasesToRestore []DatabaseRestoreResource `json:"databasesToRestore,omitempty"`
// GremlinDatabasesToRestore: List of specific gremlin databases available for restore.
GremlinDatabasesToRestore []GremlinDatabaseRestoreResource `json:"gremlinDatabasesToRestore,omitempty"`
// RestoreMode: Describes the mode of the restore.
RestoreMode *RestoreParameters_RestoreMode `json:"restoreMode,omitempty"`
// RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example:
// /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreSource *string `json:"restoreSource,omitempty"`
// RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).
RestoreTimestampInUtc *string `json:"restoreTimestampInUtc,omitempty"`
// RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful
// restore.
RestoreWithTtlDisabled *bool `json:"restoreWithTtlDisabled,omitempty"`
// TablesToRestore: List of specific tables available for restore.
TablesToRestore []string `json:"tablesToRestore,omitempty"`
}
Parameters to indicate the information about the restore.
type RestoreParametersBase ¶
type RestoreParametersBase struct {
// RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example:
// /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreSource *string `json:"restoreSource,omitempty"`
// RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).
RestoreTimestampInUtc *string `json:"restoreTimestampInUtc,omitempty"`
// RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful
// restore.
RestoreWithTtlDisabled *bool `json:"restoreWithTtlDisabled,omitempty"`
}
Parameters to indicate the information about the restore.
type RestoreParametersBase_STATUS ¶
type RestoreParametersBase_STATUS struct {
// RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example:
// /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreSource *string `json:"restoreSource,omitempty"`
// RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).
RestoreTimestampInUtc *string `json:"restoreTimestampInUtc,omitempty"`
// RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful
// restore.
RestoreWithTtlDisabled *bool `json:"restoreWithTtlDisabled,omitempty"`
}
Parameters to indicate the information about the restore.
type RestoreParameters_RestoreMode ¶
type RestoreParameters_RestoreMode string
+kubebuilder:validation:Enum={"PointInTime"}
type RestoreParameters_RestoreMode_STATUS ¶
type RestoreParameters_RestoreMode_STATUS string
type RestoreParameters_STATUS ¶
type RestoreParameters_STATUS struct {
// DatabasesToRestore: List of specific databases available for restore.
DatabasesToRestore []DatabaseRestoreResource_STATUS `json:"databasesToRestore,omitempty"`
// GremlinDatabasesToRestore: List of specific gremlin databases available for restore.
GremlinDatabasesToRestore []GremlinDatabaseRestoreResource_STATUS `json:"gremlinDatabasesToRestore,omitempty"`
// RestoreMode: Describes the mode of the restore.
RestoreMode *RestoreParameters_RestoreMode_STATUS `json:"restoreMode,omitempty"`
// RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example:
// /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreSource *string `json:"restoreSource,omitempty"`
// RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).
RestoreTimestampInUtc *string `json:"restoreTimestampInUtc,omitempty"`
// RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful
// restore.
RestoreWithTtlDisabled *bool `json:"restoreWithTtlDisabled,omitempty"`
// TablesToRestore: List of specific tables available for restore.
TablesToRestore []string `json:"tablesToRestore,omitempty"`
}
Parameters to indicate the information about the restore.
type Role ¶
type Role struct {
// Db: The database name the role is applied.
Db *string `json:"db,omitempty"`
// Role: The role name.
Role *string `json:"role,omitempty"`
}
The set of roles permitted through this Role Definition.
type Role_STATUS ¶
type Role_STATUS struct {
// Db: The database name the role is applied.
Db *string `json:"db,omitempty"`
// Role: The role name.
Role *string `json:"role,omitempty"`
}
The set of roles permitted through this Role Definition.
type SpatialSpec ¶
type SpatialSpec struct {
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
// Types: List of path's spatial type
Types []SpatialType `json:"types,omitempty"`
}
type SpatialSpec_STATUS ¶
type SpatialSpec_STATUS struct {
// Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard
// (/path/*)
Path *string `json:"path,omitempty"`
// Types: List of path's spatial type
Types []SpatialType_STATUS `json:"types,omitempty"`
}
type SpatialType ¶
type SpatialType string
Indicates the spatial type of index. +kubebuilder:validation:Enum={"LineString","MultiPolygon","Point","Polygon"}
type SqlContainerCreateUpdateProperties ¶
type SqlContainerCreateUpdateProperties struct {
// Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the
// request.
Options *CreateUpdateOptions `json:"options,omitempty"`
// Resource: The standard JSON format of a container
Resource *SqlContainerResource `json:"resource,omitempty"`
}
Properties to create and update Azure Cosmos DB container.
type SqlContainerGetProperties_Resource_STATUS ¶
type SqlContainerGetProperties_Resource_STATUS struct {
// AnalyticalStorageTtl: Analytical TTL.
AnalyticalStorageTtl *int `json:"analyticalStorageTtl,omitempty"`
// ClientEncryptionPolicy: The client encryption policy for the container.
ClientEncryptionPolicy *ClientEncryptionPolicy_STATUS `json:"clientEncryptionPolicy,omitempty"`
// ComputedProperties: List of computed properties
ComputedProperties []ComputedProperty_STATUS `json:"computedProperties,omitempty"`
// ConflictResolutionPolicy: The conflict resolution policy for the container.
ConflictResolutionPolicy *ConflictResolutionPolicy_STATUS `json:"conflictResolutionPolicy,omitempty"`
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode_STATUS `json:"createMode,omitempty"`
// DefaultTtl: Default time to live
DefaultTtl *int `json:"defaultTtl,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// Id: Name of the Cosmos DB SQL container
Id *string `json:"id,omitempty"`
// IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths
// within the container
IndexingPolicy *IndexingPolicy_STATUS `json:"indexingPolicy,omitempty"`
// PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions
PartitionKey *ContainerPartitionKey_STATUS `json:"partitionKey,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase_STATUS `json:"restoreParameters,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
// UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the
// collection in the Azure Cosmos DB service.
UniqueKeyPolicy *UniqueKeyPolicy_STATUS `json:"uniqueKeyPolicy,omitempty"`
}
type SqlContainerGetProperties_STATUS ¶
type SqlContainerGetProperties_STATUS struct {
// Options: Cosmos DB options resource object
Options *OptionsResource_STATUS `json:"options,omitempty"`
Resource *SqlContainerGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB container
type SqlContainerResource ¶
type SqlContainerResource struct {
// AnalyticalStorageTtl: Analytical TTL.
AnalyticalStorageTtl *int `json:"analyticalStorageTtl,omitempty"`
// ClientEncryptionPolicy: The client encryption policy for the container.
ClientEncryptionPolicy *ClientEncryptionPolicy `json:"clientEncryptionPolicy,omitempty"`
// ComputedProperties: List of computed properties
ComputedProperties []ComputedProperty `json:"computedProperties,omitempty"`
// ConflictResolutionPolicy: The conflict resolution policy for the container.
ConflictResolutionPolicy *ConflictResolutionPolicy `json:"conflictResolutionPolicy,omitempty"`
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode `json:"createMode,omitempty"`
// DefaultTtl: Default time to live
DefaultTtl *int `json:"defaultTtl,omitempty"`
// Id: Name of the Cosmos DB SQL container
Id *string `json:"id,omitempty"`
// IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths
// within the container
IndexingPolicy *IndexingPolicy `json:"indexingPolicy,omitempty"`
// PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions
PartitionKey *ContainerPartitionKey `json:"partitionKey,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase `json:"restoreParameters,omitempty"`
// UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the
// collection in the Azure Cosmos DB service.
UniqueKeyPolicy *UniqueKeyPolicy `json:"uniqueKeyPolicy,omitempty"`
}
Cosmos DB SQL container resource object
type SqlDatabaseContainerStoredProcedure_STATUS ¶
type SqlDatabaseContainerStoredProcedure_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB storedProcedure
Properties *SqlStoredProcedureGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlDatabaseContainerStoredProcedure_Spec ¶
type SqlDatabaseContainerStoredProcedure_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB storedProcedure.
Properties *SqlStoredProcedureCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (SqlDatabaseContainerStoredProcedure_Spec) GetAPIVersion ¶
func (procedure SqlDatabaseContainerStoredProcedure_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlDatabaseContainerStoredProcedure_Spec) GetName ¶
func (procedure *SqlDatabaseContainerStoredProcedure_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlDatabaseContainerStoredProcedure_Spec) GetType ¶
func (procedure *SqlDatabaseContainerStoredProcedure_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures"
type SqlDatabaseContainerThroughputSetting_STATUS ¶
type SqlDatabaseContainerThroughputSetting_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB resource throughput
Properties *ThroughputSettingsGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlDatabaseContainerThroughputSetting_Spec ¶
type SqlDatabaseContainerThroughputSetting_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to update Azure Cosmos DB resource throughput.
Properties *ThroughputSettingsUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (SqlDatabaseContainerThroughputSetting_Spec) GetAPIVersion ¶
func (setting SqlDatabaseContainerThroughputSetting_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlDatabaseContainerThroughputSetting_Spec) GetName ¶
func (setting *SqlDatabaseContainerThroughputSetting_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlDatabaseContainerThroughputSetting_Spec) GetType ¶
func (setting *SqlDatabaseContainerThroughputSetting_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings"
type SqlDatabaseContainerTrigger_STATUS ¶
type SqlDatabaseContainerTrigger_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB trigger
Properties *SqlTriggerGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlDatabaseContainerTrigger_Spec ¶
type SqlDatabaseContainerTrigger_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB trigger.
Properties *SqlTriggerCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (SqlDatabaseContainerTrigger_Spec) GetAPIVersion ¶
func (trigger SqlDatabaseContainerTrigger_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlDatabaseContainerTrigger_Spec) GetName ¶
func (trigger *SqlDatabaseContainerTrigger_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlDatabaseContainerTrigger_Spec) GetType ¶
func (trigger *SqlDatabaseContainerTrigger_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers"
type SqlDatabaseContainerUserDefinedFunction_STATUS ¶
type SqlDatabaseContainerUserDefinedFunction_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB userDefinedFunction
Properties *SqlUserDefinedFunctionGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlDatabaseContainerUserDefinedFunction_Spec ¶
type SqlDatabaseContainerUserDefinedFunction_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB userDefinedFunction.
Properties *SqlUserDefinedFunctionCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (SqlDatabaseContainerUserDefinedFunction_Spec) GetAPIVersion ¶
func (function SqlDatabaseContainerUserDefinedFunction_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlDatabaseContainerUserDefinedFunction_Spec) GetName ¶
func (function *SqlDatabaseContainerUserDefinedFunction_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlDatabaseContainerUserDefinedFunction_Spec) GetType ¶
func (function *SqlDatabaseContainerUserDefinedFunction_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions"
type SqlDatabaseContainer_STATUS ¶
type SqlDatabaseContainer_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB container
Properties *SqlContainerGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlDatabaseContainer_Spec ¶
type SqlDatabaseContainer_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB container.
Properties *SqlContainerCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (SqlDatabaseContainer_Spec) GetAPIVersion ¶
func (container SqlDatabaseContainer_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlDatabaseContainer_Spec) GetName ¶
func (container *SqlDatabaseContainer_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlDatabaseContainer_Spec) GetType ¶
func (container *SqlDatabaseContainer_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers"
type SqlDatabaseCreateUpdateProperties ¶
type SqlDatabaseCreateUpdateProperties struct {
// Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the
// request.
Options *CreateUpdateOptions `json:"options,omitempty"`
// Resource: The standard JSON format of a SQL database
Resource *SqlDatabaseResource `json:"resource,omitempty"`
}
Properties to create and update Azure Cosmos DB SQL database.
type SqlDatabaseGetProperties_Resource_STATUS ¶
type SqlDatabaseGetProperties_Resource_STATUS struct {
// Colls: A system generated property that specified the addressable path of the collections resource.
Colls *string `json:"_colls,omitempty"`
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode_STATUS `json:"createMode,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// Id: Name of the Cosmos DB SQL database
Id *string `json:"id,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase_STATUS `json:"restoreParameters,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
// Users: A system generated property that specifies the addressable path of the users resource.
Users *string `json:"_users,omitempty"`
}
type SqlDatabaseGetProperties_STATUS ¶
type SqlDatabaseGetProperties_STATUS struct {
// Options: Cosmos DB options resource object
Options *OptionsResource_STATUS `json:"options,omitempty"`
Resource *SqlDatabaseGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB SQL database
type SqlDatabaseResource ¶
type SqlDatabaseResource struct {
// CreateMode: Enum to indicate the mode of resource creation.
CreateMode *CreateMode `json:"createMode,omitempty"`
// Id: Name of the Cosmos DB SQL database
Id *string `json:"id,omitempty"`
// RestoreParameters: Parameters to indicate the information about the restore
RestoreParameters *RestoreParametersBase `json:"restoreParameters,omitempty"`
}
Cosmos DB SQL database resource object
type SqlDatabaseThroughputSetting_STATUS ¶
type SqlDatabaseThroughputSetting_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB resource throughput
Properties *ThroughputSettingsGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlDatabaseThroughputSetting_Spec ¶
type SqlDatabaseThroughputSetting_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to update Azure Cosmos DB resource throughput.
Properties *ThroughputSettingsUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (SqlDatabaseThroughputSetting_Spec) GetAPIVersion ¶
func (setting SqlDatabaseThroughputSetting_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlDatabaseThroughputSetting_Spec) GetName ¶
func (setting *SqlDatabaseThroughputSetting_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlDatabaseThroughputSetting_Spec) GetType ¶
func (setting *SqlDatabaseThroughputSetting_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings"
type SqlDatabase_STATUS ¶
type SqlDatabase_STATUS struct {
// Id: The unique resource identifier of the ARM resource.
Id *string `json:"id,omitempty"`
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
// Name: The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Properties: The properties of an Azure Cosmos DB SQL database
Properties *SqlDatabaseGetProperties_STATUS `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlDatabase_Spec ¶
type SqlDatabase_Spec struct {
// Location: The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties to create and update Azure Cosmos DB SQL database.
Properties *SqlDatabaseCreateUpdateProperties `json:"properties,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
}
func (SqlDatabase_Spec) GetAPIVersion ¶
func (database SqlDatabase_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlDatabase_Spec) GetName ¶
func (database *SqlDatabase_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlDatabase_Spec) GetType ¶
func (database *SqlDatabase_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"
type SqlRoleAssignmentResource ¶
type SqlRoleAssignmentResource struct {
// PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted
// through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
PrincipalId *string `json:"principalId,omitempty" optionalConfigMapPair:"PrincipalId"`
// RoleDefinitionId: The unique identifier for the associated Role Definition.
RoleDefinitionId *string `json:"roleDefinitionId,omitempty"`
// Scope: The data plane resource path for which access is being granted through this Role Assignment.
Scope *string `json:"scope,omitempty"`
}
Azure Cosmos DB SQL Role Assignment resource object.
type SqlRoleAssignmentResource_STATUS ¶
type SqlRoleAssignmentResource_STATUS struct {
// PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted
// through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
PrincipalId *string `json:"principalId,omitempty"`
// RoleDefinitionId: The unique identifier for the associated Role Definition.
RoleDefinitionId *string `json:"roleDefinitionId,omitempty"`
// Scope: The data plane resource path for which access is being granted through this Role Assignment.
Scope *string `json:"scope,omitempty"`
}
Azure Cosmos DB SQL Role Assignment resource object.
type SqlRoleAssignment_STATUS ¶
type SqlRoleAssignment_STATUS struct {
// Id: The unique resource identifier of the database account.
Id *string `json:"id,omitempty"`
// Name: The name of the database account.
Name *string `json:"name,omitempty"`
// Properties: Properties related to the Role Assignment.
Properties *SqlRoleAssignmentResource_STATUS `json:"properties,omitempty"`
// Type: The type of Azure resource.
Type *string `json:"type,omitempty"`
}
type SqlRoleAssignment_Spec ¶
type SqlRoleAssignment_Spec struct {
Name string `json:"name,omitempty"`
// Properties: Properties to create and update an Azure Cosmos DB SQL Role Assignment.
Properties *SqlRoleAssignmentResource `json:"properties,omitempty"`
}
func (SqlRoleAssignment_Spec) GetAPIVersion ¶
func (assignment SqlRoleAssignment_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2024-08-15"
func (*SqlRoleAssignment_Spec) GetName ¶
func (assignment *SqlRoleAssignment_Spec) GetName() string
GetName returns the Name of the resource
func (*SqlRoleAssignment_Spec) GetType ¶
func (assignment *SqlRoleAssignment_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments"
type SqlStoredProcedureCreateUpdateProperties ¶
type SqlStoredProcedureCreateUpdateProperties struct {
// Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the
// request.
Options *CreateUpdateOptions `json:"options,omitempty"`
// Resource: The standard JSON format of a storedProcedure
Resource *SqlStoredProcedureResource `json:"resource,omitempty"`
}
Properties to create and update Azure Cosmos DB storedProcedure.
type SqlStoredProcedureGetProperties_Resource_STATUS ¶
type SqlStoredProcedureGetProperties_Resource_STATUS struct {
// Body: Body of the Stored Procedure
Body *string `json:"body,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// Id: Name of the Cosmos DB SQL storedProcedure
Id *string `json:"id,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
}
type SqlStoredProcedureGetProperties_STATUS ¶
type SqlStoredProcedureGetProperties_STATUS struct {
Resource *SqlStoredProcedureGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB StoredProcedure
type SqlStoredProcedureResource ¶
type SqlStoredProcedureResource struct {
// Body: Body of the Stored Procedure
Body *string `json:"body,omitempty"`
// Id: Name of the Cosmos DB SQL storedProcedure
Id *string `json:"id,omitempty"`
}
Cosmos DB SQL storedProcedure resource object
type SqlTriggerCreateUpdateProperties ¶
type SqlTriggerCreateUpdateProperties struct {
// Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the
// request.
Options *CreateUpdateOptions `json:"options,omitempty"`
// Resource: The standard JSON format of a trigger
Resource *SqlTriggerResource `json:"resource,omitempty"`
}
Properties to create and update Azure Cosmos DB trigger.
type SqlTriggerGetProperties_Resource_STATUS ¶
type SqlTriggerGetProperties_Resource_STATUS struct {
// Body: Body of the Trigger
Body *string `json:"body,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// Id: Name of the Cosmos DB SQL trigger
Id *string `json:"id,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// TriggerOperation: The operation the trigger is associated with
TriggerOperation *SqlTriggerGetProperties_Resource_TriggerOperation_STATUS `json:"triggerOperation,omitempty"`
// TriggerType: Type of the Trigger
TriggerType *SqlTriggerGetProperties_Resource_TriggerType_STATUS `json:"triggerType,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
}
type SqlTriggerGetProperties_Resource_TriggerOperation_STATUS ¶
type SqlTriggerGetProperties_Resource_TriggerOperation_STATUS string
type SqlTriggerGetProperties_Resource_TriggerType_STATUS ¶
type SqlTriggerGetProperties_Resource_TriggerType_STATUS string
type SqlTriggerGetProperties_STATUS ¶
type SqlTriggerGetProperties_STATUS struct {
Resource *SqlTriggerGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB trigger
type SqlTriggerResource ¶
type SqlTriggerResource struct {
// Body: Body of the Trigger
Body *string `json:"body,omitempty"`
// Id: Name of the Cosmos DB SQL trigger
Id *string `json:"id,omitempty"`
// TriggerOperation: The operation the trigger is associated with
TriggerOperation *SqlTriggerResource_TriggerOperation `json:"triggerOperation,omitempty"`
// TriggerType: Type of the Trigger
TriggerType *SqlTriggerResource_TriggerType `json:"triggerType,omitempty"`
}
Cosmos DB SQL trigger resource object
type SqlTriggerResource_TriggerOperation ¶
type SqlTriggerResource_TriggerOperation string
+kubebuilder:validation:Enum={"All","Create","Delete","Replace","Update"}
type SqlTriggerResource_TriggerType ¶
type SqlTriggerResource_TriggerType string
+kubebuilder:validation:Enum={"Post","Pre"}
type SqlUserDefinedFunctionCreateUpdateProperties ¶
type SqlUserDefinedFunctionCreateUpdateProperties struct {
// Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the
// request.
Options *CreateUpdateOptions `json:"options,omitempty"`
// Resource: The standard JSON format of a userDefinedFunction
Resource *SqlUserDefinedFunctionResource `json:"resource,omitempty"`
}
Properties to create and update Azure Cosmos DB userDefinedFunction.
type SqlUserDefinedFunctionGetProperties_Resource_STATUS ¶
type SqlUserDefinedFunctionGetProperties_Resource_STATUS struct {
// Body: Body of the User Defined Function
Body *string `json:"body,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// Id: Name of the Cosmos DB SQL userDefinedFunction
Id *string `json:"id,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
}
type SqlUserDefinedFunctionGetProperties_STATUS ¶
type SqlUserDefinedFunctionGetProperties_STATUS struct {
Resource *SqlUserDefinedFunctionGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB userDefinedFunction
type SqlUserDefinedFunctionResource ¶
type SqlUserDefinedFunctionResource struct {
// Body: Body of the User Defined Function
Body *string `json:"body,omitempty"`
// Id: Name of the Cosmos DB SQL userDefinedFunction
Id *string `json:"id,omitempty"`
}
Cosmos DB SQL userDefinedFunction resource object
type SystemData_CreatedByType_STATUS ¶
type SystemData_CreatedByType_STATUS string
type SystemData_LastModifiedByType_STATUS ¶
type SystemData_LastModifiedByType_STATUS string
type SystemData_STATUS ¶
type SystemData_STATUS struct {
// CreatedAt: The timestamp of resource creation (UTC).
CreatedAt *string `json:"createdAt,omitempty"`
// CreatedBy: The identity that created the resource.
CreatedBy *string `json:"createdBy,omitempty"`
// CreatedByType: The type of identity that created the resource.
CreatedByType *SystemData_CreatedByType_STATUS `json:"createdByType,omitempty"`
// LastModifiedAt: The timestamp of resource last modification (UTC)
LastModifiedAt *string `json:"lastModifiedAt,omitempty"`
// LastModifiedBy: The identity that last modified the resource.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// LastModifiedByType: The type of identity that last modified the resource.
LastModifiedByType *SystemData_LastModifiedByType_STATUS `json:"lastModifiedByType,omitempty"`
}
Metadata pertaining to creation and last modification of the resource.
type ThroughputPolicyResource ¶
type ThroughputPolicyResource struct {
// IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in.
IncrementPercent *int `json:"incrementPercent,omitempty"`
// IsEnabled: Determines whether the ThroughputPolicy is active or not
IsEnabled *bool `json:"isEnabled,omitempty"`
}
Cosmos DB resource throughput policy
type ThroughputPolicyResource_STATUS ¶
type ThroughputPolicyResource_STATUS struct {
// IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in.
IncrementPercent *int `json:"incrementPercent,omitempty"`
// IsEnabled: Determines whether the ThroughputPolicy is active or not
IsEnabled *bool `json:"isEnabled,omitempty"`
}
Cosmos DB resource throughput policy
type ThroughputSettingsGetProperties_Resource_STATUS ¶
type ThroughputSettingsGetProperties_Resource_STATUS struct {
// AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is
// required, but not both.
AutoscaleSettings *AutoscaleSettingsResource_STATUS `json:"autoscaleSettings,omitempty"`
// Etag: A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
// InstantMaximumThroughput: The offer throughput value to instantly scale up without triggering splits
InstantMaximumThroughput *string `json:"instantMaximumThroughput,omitempty"`
// MinimumThroughput: The minimum throughput of the resource
MinimumThroughput *string `json:"minimumThroughput,omitempty"`
// OfferReplacePending: The throughput replace is pending
OfferReplacePending *string `json:"offerReplacePending,omitempty"`
// Rid: A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// SoftAllowedMaximumThroughput: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can
// be specified
SoftAllowedMaximumThroughput *string `json:"softAllowedMaximumThroughput,omitempty"`
// Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required,
// but not both.
Throughput *int `json:"throughput,omitempty"`
// Ts: A system generated property that denotes the last updated timestamp of the resource.
Ts *float64 `json:"_ts,omitempty"`
}
type ThroughputSettingsGetProperties_STATUS ¶
type ThroughputSettingsGetProperties_STATUS struct {
Resource *ThroughputSettingsGetProperties_Resource_STATUS `json:"resource,omitempty"`
}
The properties of an Azure Cosmos DB resource throughput
type ThroughputSettingsResource ¶
type ThroughputSettingsResource struct {
// AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is
// required, but not both.
AutoscaleSettings *AutoscaleSettingsResource `json:"autoscaleSettings,omitempty"`
// Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required,
// but not both.
Throughput *int `json:"throughput,omitempty"`
}
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.
type ThroughputSettingsUpdateProperties ¶
type ThroughputSettingsUpdateProperties struct {
// Resource: The standard JSON format of a resource throughput
Resource *ThroughputSettingsResource `json:"resource,omitempty"`
}
Properties to update Azure Cosmos DB resource throughput.
type UniqueKey ¶
type UniqueKey struct {
// Paths: List of paths must be unique for each document in the Azure Cosmos DB service
Paths []string `json:"paths,omitempty"`
}
The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
type UniqueKeyPolicy ¶
type UniqueKeyPolicy struct {
// UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure
// Cosmos DB service.
UniqueKeys []UniqueKey `json:"uniqueKeys,omitempty"`
}
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
type UniqueKeyPolicy_STATUS ¶
type UniqueKeyPolicy_STATUS struct {
// UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure
// Cosmos DB service.
UniqueKeys []UniqueKey_STATUS `json:"uniqueKeys,omitempty"`
}
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
type UniqueKey_STATUS ¶
type UniqueKey_STATUS struct {
// Paths: List of paths must be unique for each document in the Azure Cosmos DB service
Paths []string `json:"paths,omitempty"`
}
The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
type UserAssignedIdentityDetails ¶
type UserAssignedIdentityDetails struct {
}
Information about the user assigned identity for the resource
type VirtualNetworkRule ¶
type VirtualNetworkRule struct {
Id *string `json:"id,omitempty"`
// IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.
IgnoreMissingVNetServiceEndpoint *bool `json:"ignoreMissingVNetServiceEndpoint,omitempty"`
}
Virtual Network ACL Rule object
type VirtualNetworkRule_STATUS ¶
type VirtualNetworkRule_STATUS struct {
// Id: Resource ID of a subnet, for example:
// /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
Id *string `json:"id,omitempty"`
// IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.
IgnoreMissingVNetServiceEndpoint *bool `json:"ignoreMissingVNetServiceEndpoint,omitempty"`
}
Virtual Network ACL Rule object
Source Files
¶
- database_account_spec_types_gen.go
- database_account_status_types_gen.go
- mongodb_database_collection_spec_types_gen.go
- mongodb_database_collection_status_types_gen.go
- mongodb_database_collection_throughput_setting_spec_types_gen.go
- mongodb_database_collection_throughput_setting_status_types_gen.go
- mongodb_database_spec_types_gen.go
- mongodb_database_status_types_gen.go
- mongodb_database_throughput_setting_spec_types_gen.go
- mongodb_database_throughput_setting_status_types_gen.go
- mongodb_user_definition_spec_types_gen.go
- mongodb_user_definition_status_types_gen.go
- sql_database_container_spec_types_gen.go
- sql_database_container_status_types_gen.go
- sql_database_container_stored_procedure_spec_types_gen.go
- sql_database_container_stored_procedure_status_types_gen.go
- sql_database_container_throughput_setting_spec_types_gen.go
- sql_database_container_throughput_setting_status_types_gen.go
- sql_database_container_trigger_spec_types_gen.go
- sql_database_container_trigger_status_types_gen.go
- sql_database_container_user_defined_function_spec_types_gen.go
- sql_database_container_user_defined_function_status_types_gen.go
- sql_database_spec_types_gen.go
- sql_database_status_types_gen.go
- sql_database_throughput_setting_spec_types_gen.go
- sql_database_throughput_setting_status_types_gen.go
- sql_role_assignment_spec_types_gen.go
- sql_role_assignment_status_types_gen.go