arm

package
v2.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 23, 2026 License: MIT Imports: 1 Imported by: 0

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.

Index

Constants

View Source 
const (
	ProvisioningState_STATUS_Canceled   = ProvisioningState_STATUS("Canceled")
	ProvisioningState_STATUS_Dropping   = ProvisioningState_STATUS("Dropping")
	ProvisioningState_STATUS_Failed     = ProvisioningState_STATUS("Failed")
	ProvisioningState_STATUS_InProgress = ProvisioningState_STATUS("InProgress")
	ProvisioningState_STATUS_Succeeded  = ProvisioningState_STATUS("Succeeded")
	ProvisioningState_STATUS_Updating   = ProvisioningState_STATUS("Updating")
)
View Source 
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")
)
View Source 
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")
)
View Source 
const (
	CreateMode_Default            = CreateMode("Default")
	CreateMode_GeoReplica         = CreateMode("GeoReplica")
	CreateMode_PointInTimeRestore = CreateMode("PointInTimeRestore")
	CreateMode_Replica            = CreateMode("Replica")
)
View Source 
const (
	PublicNetworkAccess_Disabled = PublicNetworkAccess("Disabled")
	PublicNetworkAccess_Enabled  = PublicNetworkAccess("Enabled")
)
View Source 
const (
	HighAvailabilityMode_Disabled               = HighAvailabilityMode("Disabled")
	HighAvailabilityMode_SameZone               = HighAvailabilityMode("SameZone")
	HighAvailabilityMode_ZoneRedundantPreferred = HighAvailabilityMode("ZoneRedundantPreferred")
)
View Source 
const (
	CreateMode_STATUS_Default            = CreateMode_STATUS("Default")
	CreateMode_STATUS_GeoReplica         = CreateMode_STATUS("GeoReplica")
	CreateMode_STATUS_PointInTimeRestore = CreateMode_STATUS("PointInTimeRestore")
	CreateMode_STATUS_Replica            = CreateMode_STATUS("Replica")
)
View Source 
const (
	MongoClusterStatus_STATUS_Dropping     = MongoClusterStatus_STATUS("Dropping")
	MongoClusterStatus_STATUS_Provisioning = MongoClusterStatus_STATUS("Provisioning")
	MongoClusterStatus_STATUS_Ready        = MongoClusterStatus_STATUS("Ready")
	MongoClusterStatus_STATUS_Starting     = MongoClusterStatus_STATUS("Starting")
	MongoClusterStatus_STATUS_Stopped      = MongoClusterStatus_STATUS("Stopped")
	MongoClusterStatus_STATUS_Stopping     = MongoClusterStatus_STATUS("Stopping")
	MongoClusterStatus_STATUS_Updating     = MongoClusterStatus_STATUS("Updating")
)
View Source 
const (
	PublicNetworkAccess_STATUS_Disabled = PublicNetworkAccess_STATUS("Disabled")
	PublicNetworkAccess_STATUS_Enabled  = PublicNetworkAccess_STATUS("Enabled")
)
View Source 
const (
	HighAvailabilityMode_STATUS_Disabled               = HighAvailabilityMode_STATUS("Disabled")
	HighAvailabilityMode_STATUS_SameZone               = HighAvailabilityMode_STATUS("SameZone")
	HighAvailabilityMode_STATUS_ZoneRedundantPreferred = HighAvailabilityMode_STATUS("ZoneRedundantPreferred")
)
View Source 
const (
	ReplicationRole_STATUS_AsyncReplica    = ReplicationRole_STATUS("AsyncReplica")
	ReplicationRole_STATUS_GeoAsyncReplica = ReplicationRole_STATUS("GeoAsyncReplica")
	ReplicationRole_STATUS_Primary         = ReplicationRole_STATUS("Primary")
)
View Source 
const (
	ReplicationState_STATUS_Active        = ReplicationState_STATUS("Active")
	ReplicationState_STATUS_Broken        = ReplicationState_STATUS("Broken")
	ReplicationState_STATUS_Catchup       = ReplicationState_STATUS("Catchup")
	ReplicationState_STATUS_Provisioning  = ReplicationState_STATUS("Provisioning")
	ReplicationState_STATUS_Reconfiguring = ReplicationState_STATUS("Reconfiguring")
	ReplicationState_STATUS_Updating      = ReplicationState_STATUS("Updating")
)
View Source 
const PreviewFeature_GeoReplicas = PreviewFeature("GeoReplicas")
View Source 
const PreviewFeature_STATUS_GeoReplicas = PreviewFeature_STATUS("GeoReplicas")

Variables

This section is empty.

Functions

This section is empty.

Types

type AdministratorProperties 

type AdministratorProperties struct {
	// Password: The administrator password.
	Password *string `json:"password,omitempty"`

	// UserName: The administrator user name.
	UserName *string `json:"userName,omitempty"`
}

The local administrator login properties.

type AdministratorProperties_STATUS 

type AdministratorProperties_STATUS struct {
	// UserName: The administrator user name.
	UserName *string `json:"userName,omitempty"`
}

The local administrator login properties.

type BackupProperties_STATUS 

type BackupProperties_STATUS struct {
	// EarliestRestoreTime: Earliest restore timestamp in UTC ISO8601 format.
	EarliestRestoreTime *string `json:"earliestRestoreTime,omitempty"`
}

The backup properties of the cluster. This includes the earliest restore time and retention settings.

type ComputeProperties 

type ComputeProperties struct {
	// Tier: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values:
	// 'M30', 'M40'.
	Tier *string `json:"tier,omitempty"`
}

The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied to servers in the cluster.

type ComputeProperties_STATUS 

type ComputeProperties_STATUS struct {
	// Tier: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values:
	// 'M30', 'M40'.
	Tier *string `json:"tier,omitempty"`
}

The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied to servers in the cluster.

type CreateMode 

type CreateMode string

The mode that the Mongo Cluster is created with. +kubebuilder:validation:Enum={"Default","GeoReplica","PointInTimeRestore","Replica"}

type CreateMode_STATUS 

type CreateMode_STATUS string

The mode that the Mongo Cluster is created with.

type FirewallRuleProperties 

type FirewallRuleProperties struct {
	// EndIpAddress: The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
	EndIpAddress *string `json:"endIpAddress,omitempty"`

	// StartIpAddress: The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
	StartIpAddress *string `json:"startIpAddress,omitempty"`
}

The properties of a mongo cluster firewall rule.

type FirewallRuleProperties_STATUS 

type FirewallRuleProperties_STATUS struct {
	// EndIpAddress: The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
	EndIpAddress *string `json:"endIpAddress,omitempty"`

	// ProvisioningState: The provisioning state of the firewall rule.
	ProvisioningState *ProvisioningState_STATUS `json:"provisioningState,omitempty"`

	// StartIpAddress: The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
	StartIpAddress *string `json:"startIpAddress,omitempty"`
}

The properties of a mongo cluster firewall rule.

type FirewallRule_STATUS 

type FirewallRule_STATUS struct {
	// Id: Fully qualified resource ID for the resource. E.g.
	// "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	Id *string `json:"id,omitempty"`

	// Name: The name of the resource
	Name *string `json:"name,omitempty"`

	// Properties: The resource-specific properties for this resource.
	Properties *FirewallRuleProperties_STATUS `json:"properties,omitempty"`

	// SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData_STATUS `json:"systemData,omitempty"`

	// Type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

type FirewallRule_Spec 

type FirewallRule_Spec struct {
	Name string `json:"name,omitempty"`

	// Properties: The resource-specific properties for this resource.
	Properties *FirewallRuleProperties `json:"properties,omitempty"`
}

func (FirewallRule_Spec) GetAPIVersion 

func (rule FirewallRule_Spec) GetAPIVersion() string

GetAPIVersion returns the ARM API version of the resource. This is always "2024-07-01"

func (*FirewallRule_Spec) GetName 

func (rule *FirewallRule_Spec) GetName() string

GetName returns the Name of the resource

func (*FirewallRule_Spec) GetType 

func (rule *FirewallRule_Spec) GetType() string

GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/mongoClusters/firewallRules"

type HighAvailabilityMode 

type HighAvailabilityMode string

The high availability modes for a cluster. +kubebuilder:validation:Enum={"Disabled","SameZone","ZoneRedundantPreferred"}

type HighAvailabilityMode_STATUS 

type HighAvailabilityMode_STATUS string

The high availability modes for a cluster.

type HighAvailabilityProperties 

type HighAvailabilityProperties struct {
	// TargetMode: The target high availability mode requested for the cluster.
	TargetMode *HighAvailabilityMode `json:"targetMode,omitempty"`
}

The high availability properties of the cluster.

type HighAvailabilityProperties_STATUS 

type HighAvailabilityProperties_STATUS struct {
	// TargetMode: The target high availability mode requested for the cluster.
	TargetMode *HighAvailabilityMode_STATUS `json:"targetMode,omitempty"`
}

The high availability properties of the cluster.

type MongoClusterProperties 

type MongoClusterProperties struct {
	// Administrator: The local administrator properties for the mongo cluster.
	Administrator *AdministratorProperties `json:"administrator,omitempty"`

	// Compute: The compute properties of the mongo cluster.
	Compute *ComputeProperties `json:"compute,omitempty"`

	// CreateMode: The mode to create a mongo cluster.
	CreateMode *CreateMode `json:"createMode,omitempty"`

	// HighAvailability: The high availability properties of the mongo cluster.
	HighAvailability *HighAvailabilityProperties `json:"highAvailability,omitempty"`

	// PreviewFeatures: List of private endpoint connections.
	PreviewFeatures []PreviewFeature `json:"previewFeatures,omitempty"`

	// PublicNetworkAccess: Whether or not public endpoint access is allowed for this mongo cluster.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// ReplicaParameters: The parameters to create a replica mongo cluster.
	ReplicaParameters *MongoClusterReplicaParameters `json:"replicaParameters,omitempty"`

	// RestoreParameters: The parameters to create a point-in-time restore mongo cluster.
	RestoreParameters *MongoClusterRestoreParameters `json:"restoreParameters,omitempty"`

	// ServerVersion: The Mongo DB server version. Defaults to the latest available version if not specified.
	ServerVersion *string `json:"serverVersion,omitempty"`

	// Sharding: The sharding properties of the mongo cluster.
	Sharding *ShardingProperties `json:"sharding,omitempty"`

	// Storage: The storage properties of the mongo cluster.
	Storage *StorageProperties `json:"storage,omitempty"`
}

The properties of a mongo cluster.

type MongoClusterProperties_STATUS 

type MongoClusterProperties_STATUS struct {
	// Administrator: The local administrator properties for the mongo cluster.
	Administrator *AdministratorProperties_STATUS `json:"administrator,omitempty"`

	// Backup: The backup properties of the mongo cluster.
	Backup *BackupProperties_STATUS `json:"backup,omitempty"`

	// ClusterStatus: The status of the mongo cluster.
	ClusterStatus *MongoClusterStatus_STATUS `json:"clusterStatus,omitempty"`

	// Compute: The compute properties of the mongo cluster.
	Compute *ComputeProperties_STATUS `json:"compute,omitempty"`

	// ConnectionString: The default mongo connection string for the cluster.
	ConnectionString *string `json:"connectionString,omitempty"`

	// CreateMode: The mode to create a mongo cluster.
	CreateMode *CreateMode_STATUS `json:"createMode,omitempty"`

	// HighAvailability: The high availability properties of the mongo cluster.
	HighAvailability *HighAvailabilityProperties_STATUS `json:"highAvailability,omitempty"`

	// InfrastructureVersion: The infrastructure version the cluster is provisioned on.
	InfrastructureVersion *string `json:"infrastructureVersion,omitempty"`

	// PreviewFeatures: List of private endpoint connections.
	PreviewFeatures []PreviewFeature_STATUS `json:"previewFeatures,omitempty"`

	// PrivateEndpointConnections: List of private endpoint connections.
	PrivateEndpointConnections []PrivateEndpointConnection_STATUS `json:"privateEndpointConnections,omitempty"`

	// ProvisioningState: The provisioning state of the mongo cluster.
	ProvisioningState *ProvisioningState_STATUS `json:"provisioningState,omitempty"`

	// PublicNetworkAccess: Whether or not public endpoint access is allowed for this mongo cluster.
	PublicNetworkAccess *PublicNetworkAccess_STATUS `json:"publicNetworkAccess,omitempty"`

	// Replica: The replication properties for the mongo cluster
	Replica *ReplicationProperties_STATUS `json:"replica,omitempty"`

	// ReplicaParameters: The parameters to create a replica mongo cluster.
	ReplicaParameters *MongoClusterReplicaParameters_STATUS `json:"replicaParameters,omitempty"`

	// RestoreParameters: The parameters to create a point-in-time restore mongo cluster.
	RestoreParameters *MongoClusterRestoreParameters_STATUS `json:"restoreParameters,omitempty"`

	// ServerVersion: The Mongo DB server version. Defaults to the latest available version if not specified.
	ServerVersion *string `json:"serverVersion,omitempty"`

	// Sharding: The sharding properties of the mongo cluster.
	Sharding *ShardingProperties_STATUS `json:"sharding,omitempty"`

	// Storage: The storage properties of the mongo cluster.
	Storage *StorageProperties_STATUS `json:"storage,omitempty"`
}

The properties of a mongo cluster.

type MongoClusterReplicaParameters 

type MongoClusterReplicaParameters struct {
	// SourceLocation: The location of the source cluster
	SourceLocation *string `json:"sourceLocation,omitempty"`

	// SourceResourceId: The id of the replication source cluster.
	SourceResourceId *string `json:"sourceResourceId,omitempty"`
}

Parameters used for replica operations.

type MongoClusterReplicaParameters_STATUS 

type MongoClusterReplicaParameters_STATUS struct {
	// SourceLocation: The location of the source cluster
	SourceLocation *string `json:"sourceLocation,omitempty"`

	// SourceResourceId: The id of the replication source cluster.
	SourceResourceId *string `json:"sourceResourceId,omitempty"`
}

Parameters used for replica operations.

type MongoClusterRestoreParameters 

type MongoClusterRestoreParameters struct {
	// PointInTimeUTC: UTC point in time to restore a mongo cluster
	PointInTimeUTC *string `json:"pointInTimeUTC,omitempty"`

	// SourceResourceId: Resource ID to locate the source cluster to restore
	SourceResourceId *string `json:"sourceResourceId,omitempty"`
}

Parameters used for restore operations

type MongoClusterRestoreParameters_STATUS 

type MongoClusterRestoreParameters_STATUS struct {
	// PointInTimeUTC: UTC point in time to restore a mongo cluster
	PointInTimeUTC *string `json:"pointInTimeUTC,omitempty"`

	// SourceResourceId: Resource ID to locate the source cluster to restore
	SourceResourceId *string `json:"sourceResourceId,omitempty"`
}

Parameters used for restore operations

type MongoClusterStatus_STATUS 

type MongoClusterStatus_STATUS string

The status of the Mongo cluster resource.

type MongoCluster_STATUS 

type MongoCluster_STATUS struct {
	// Id: Fully qualified resource ID for the resource. E.g.
	// "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	Id *string `json:"id,omitempty"`

	// Location: The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Name: The name of the resource
	Name *string `json:"name,omitempty"`

	// Properties: The resource-specific properties for this resource.
	Properties *MongoClusterProperties_STATUS `json:"properties,omitempty"`

	// SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData_STATUS `json:"systemData,omitempty"`

	// Tags: Resource tags.
	Tags map[string]string `json:"tags,omitempty"`

	// Type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Represents a mongo cluster resource.

type MongoCluster_Spec 

type MongoCluster_Spec struct {
	// Location: The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	Name     string  `json:"name,omitempty"`

	// Properties: The resource-specific properties for this resource.
	Properties *MongoClusterProperties `json:"properties,omitempty"`

	// Tags: Resource tags.
	Tags map[string]string `json:"tags,omitempty"`
}

func (MongoCluster_Spec) GetAPIVersion 

func (cluster MongoCluster_Spec) GetAPIVersion() string

GetAPIVersion returns the ARM API version of the resource. This is always "2024-07-01"

func (*MongoCluster_Spec) GetName 

func (cluster *MongoCluster_Spec) GetName() string

GetName returns the Name of the resource

func (*MongoCluster_Spec) GetType 

func (cluster *MongoCluster_Spec) GetType() string

GetType returns the ARM Type of the resource. This is always "Microsoft.DocumentDB/mongoClusters"

type PreviewFeature 

type PreviewFeature string

Preview features that can be enabled on a mongo cluster. +kubebuilder:validation:Enum={"GeoReplicas"}

type PreviewFeature_STATUS 

type PreviewFeature_STATUS string

Preview features that can be enabled on a mongo cluster.

type PrivateEndpointConnection_STATUS 

type PrivateEndpointConnection_STATUS struct {
	// Id: Fully qualified resource ID for the resource. E.g.
	// "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	Id *string `json:"id,omitempty"`
}

The private endpoint connection resource.

type ProvisioningState_STATUS 

type ProvisioningState_STATUS string

The provisioning state of the last accepted operation.

type PublicNetworkAccess 

type PublicNetworkAccess string

Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is 'Enabled' +kubebuilder:validation:Enum={"Disabled","Enabled"}

type PublicNetworkAccess_STATUS 

type PublicNetworkAccess_STATUS string

Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is 'Enabled'

type ReplicationProperties_STATUS 

type ReplicationProperties_STATUS struct {
	// ReplicationState: The replication link state of the replica cluster.
	ReplicationState *ReplicationState_STATUS `json:"replicationState,omitempty"`

	// Role: The replication role of the cluster
	Role *ReplicationRole_STATUS `json:"role,omitempty"`

	// SourceResourceId: The resource id the source cluster for the replica cluster.
	SourceResourceId *string `json:"sourceResourceId,omitempty"`
}

Replica properties of the mongo cluster.

type ReplicationRole_STATUS 

type ReplicationRole_STATUS string

Replication role of the mongo cluster.

type ReplicationState_STATUS 

type ReplicationState_STATUS string

The state of the replication link between the replica and source cluster.

type ShardingProperties 

type ShardingProperties struct {
	// ShardCount: Number of shards to provision on the cluster.
	ShardCount *int `json:"shardCount,omitempty"`
}

The sharding properties of the cluster. This includes the shard count and scaling options for the cluster.

type ShardingProperties_STATUS 

type ShardingProperties_STATUS struct {
	// ShardCount: Number of shards to provision on the cluster.
	ShardCount *int `json:"shardCount,omitempty"`
}

The sharding properties of the cluster. This includes the shard count and scaling options for the cluster.

type StorageProperties 

type StorageProperties struct {
	// SizeGb: The size of the data disk assigned to each server.
	SizeGb *int `json:"sizeGb,omitempty"`
}

The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster.

type StorageProperties_STATUS 

type StorageProperties_STATUS struct {
	// SizeGb: The size of the data disk assigned to each server.
	SizeGb *int `json:"sizeGb,omitempty"`
}

The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster.

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.