// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// Code generated by Microsoft (R) Go Code Generator. DO NOT EDIT.

package armmongocluster

import "time"

// AdministratorProperties - The local administrator login properties.
type AdministratorProperties struct {
	// The administrator password.
	Password *string

	// The administrator user name.
	UserName *string
}

// AuthConfigProperties - The authentication configuration for the Mongo cluster.
type AuthConfigProperties struct {
	// Allowed authentication modes for data access on the cluster.
	AllowedModes []*AuthenticationMode
}

// BackupProperties - The backup properties of the cluster. This includes the earliest restore time and retention settings.
type BackupProperties struct {
	// READ-ONLY; Earliest restore timestamp in UTC ISO8601 format.
	EarliestRestoreTime *string
}

// CheckNameAvailabilityRequest - The check availability request body.
type CheckNameAvailabilityRequest struct {
	// The name of the resource for which availability needs to be checked.
	Name *string

	// The resource type.
	Type *string
}

// CheckNameAvailabilityResponse - The check availability result.
type CheckNameAvailabilityResponse struct {
	// Detailed reason why the given name is not available.
	Message *string

	// Indicates if the resource name is available.
	NameAvailable *bool

	// The reason why the given name is not available.
	Reason *CheckNameAvailabilityReason
}

// ComputeProperties - The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied
// to servers in the cluster.
type ComputeProperties struct {
	// 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
}

// ConnectionString - Connection string for the mongo cluster
type ConnectionString struct {
	// READ-ONLY; Value of the connection string
	ConnectionString *string

	// READ-ONLY; Description of the connection string
	Description *string

	// READ-ONLY; Name of the connection string.
	Name *string
}

// CustomerManagedKeyEncryptionProperties - Customer managed key encryption settings.
type CustomerManagedKeyEncryptionProperties struct {
	// The identity used to access the key encryption key.
	KeyEncryptionKeyIdentity *KeyEncryptionKeyIdentity

	// The URI of the key vault key used for encryption.
	KeyEncryptionKeyURL *string
}

// DataAPIProperties - Data API properties.
type DataAPIProperties struct {
	// The mode to indicate whether the Mongo Data API is enabled for a cluster.
	Mode *DataAPIMode
}

// DatabaseRole - Database role definition that is assigned to a user.
type DatabaseRole struct {
	// REQUIRED; Database scope that the role is assigned to.
	Db *string

	// REQUIRED; The role that is assigned to the user on the database scope.
	Role *UserRole
}

// EncryptionProperties - The encryption configuration for the mongo cluster.
type EncryptionProperties struct {
	// Customer managed key encryption settings.
	CustomerManagedKeyEncryption *CustomerManagedKeyEncryptionProperties
}

// EntraIdentityProvider - Defines a Microsoft Entra ID Mongo user.
type EntraIdentityProvider struct {
	// REQUIRED; The Entra identity properties for the user.
	Properties *EntraIdentityProviderProperties

	// CONSTANT; The type of identity provider that the user belongs to.
	// Field has constant value IdentityProviderTypeMicrosoftEntraID, any specified value is ignored.
	Type *IdentityProviderType
}

// GetIdentityProvider implements the IdentityProviderClassification interface for type EntraIdentityProvider.
func (e *EntraIdentityProvider) GetIdentityProvider() *IdentityProvider {
	return &IdentityProvider{
		Type: e.Type,
	}
}

// EntraIdentityProviderProperties - Microsoft Entra ID provider properties.
type EntraIdentityProviderProperties struct {
	// REQUIRED; The principal type of the user.
	PrincipalType *EntraPrincipalType
}

// FirewallRule - Represents a mongo cluster firewall rule.
type FirewallRule struct {
	// The resource-specific properties for this resource.
	Properties *FirewallRuleProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

// FirewallRuleListResult - The response of a FirewallRule list operation.
type FirewallRuleListResult struct {
	// REQUIRED; The FirewallRule items on this page
	Value []*FirewallRule

	// The link to the next page of items
	NextLink *string
}

// FirewallRuleProperties - The properties of a mongo cluster firewall rule.
type FirewallRuleProperties struct {
	// REQUIRED; The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
	EndIPAddress *string

	// REQUIRED; The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
	StartIPAddress *string

	// READ-ONLY; The provisioning state of the firewall rule.
	ProvisioningState *ProvisioningState
}

// HighAvailabilityProperties - The high availability properties of the cluster.
type HighAvailabilityProperties struct {
	// The target high availability mode requested for the cluster.
	TargetMode *HighAvailabilityMode
}

// IdentityProvider - Defines a user's identity provider definition.
type IdentityProvider struct {
	// REQUIRED; The type of identity provider that the user belongs to.
	Type *IdentityProviderType
}

// GetIdentityProvider implements the IdentityProviderClassification interface for type IdentityProvider.
func (i *IdentityProvider) GetIdentityProvider() *IdentityProvider { return i }

// KeyEncryptionKeyIdentity - The identity used for key encryption key.
type KeyEncryptionKeyIdentity struct {
	// The type of identity. Only 'UserAssignedIdentity' is supported.
	IdentityType *KeyEncryptionKeyIdentityType

	// The user assigned identity resource id.
	UserAssignedIdentityResourceID *string
}

// ListConnectionStringsResult - The connection strings for the given mongo cluster.
type ListConnectionStringsResult struct {
	// READ-ONLY; An array that contains the connection strings for a mongo cluster.
	ConnectionStrings []*ConnectionString
}

// ListResult - The response of a MongoCluster list operation.
type ListResult struct {
	// REQUIRED; The MongoCluster items on this page
	Value []*MongoCluster

	// The link to the next page of items
	NextLink *string
}

// ManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities)
type ManagedServiceIdentity struct {
	// REQUIRED; The type of managed identity assigned to this resource.
	Type *ManagedServiceIdentityType

	// The identities assigned to this resource by the user.
	UserAssignedIdentities map[string]*UserAssignedIdentity

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string
}

// MongoCluster - Represents a mongo cluster resource.
type MongoCluster struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The managed service identities assigned to this resource.
	Identity *ManagedServiceIdentity

	// The resource-specific properties for this resource.
	Properties *Properties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

// Operation - REST API Operation
//
// Details of a REST API operation, returned from the Resource Provider Operations API
type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay

	// READ-ONLY; Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType

	// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure
	// Resource Manager/control-plane operations.
	IsDataAction *bool

	// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write",
	// "Microsoft.Compute/virtualMachines/capture/action"
	Name *string

	// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default
	// value is "user,system"
	Origin *Origin
}

// OperationDisplay - Localized display information for and operation.
type OperationDisplay struct {
	// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string

	// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual
	// Machine", "Restart Virtual Machine".
	Operation *string

	// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft
	// Compute".
	Provider *string

	// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job
	// Schedule Collections".
	Resource *string
}

// OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to
// get the next set of results.
type OperationListResult struct {
	// REQUIRED; The Operation items on this page
	Value []*Operation

	// The link to the next page of items
	NextLink *string
}

// PrivateEndpoint - The private endpoint resource.
type PrivateEndpoint struct {
	// READ-ONLY; The resource identifier of the private endpoint
	ID *string
}

// PrivateEndpointConnection - The private endpoint connection resource
type PrivateEndpointConnection struct {
	// The private endpoint connection properties
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

// PrivateEndpointConnectionProperties - Properties of the private endpoint connection.
type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState

	// The private endpoint resource.
	PrivateEndpoint *PrivateEndpoint

	// READ-ONLY; The group ids for the private endpoint resource.
	GroupIDs []*string

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState
}

// PrivateEndpointConnectionResource - Concrete proxy resource types can be created by aliasing this type using a specific
// property type.
type PrivateEndpointConnectionResource struct {
	// The resource-specific properties for this resource.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

// PrivateEndpointConnectionResourceListResult - The response of a PrivateEndpointConnectionResource list operation.
type PrivateEndpointConnectionResourceListResult struct {
	// REQUIRED; The PrivateEndpointConnectionResource items on this page
	Value []*PrivateEndpointConnectionResource

	// The link to the next page of items
	NextLink *string
}

// PrivateLinkResource - Concrete proxy resource types can be created by aliasing this type using a specific property type.
type PrivateLinkResource struct {
	// The resource-specific properties for this resource.
	Properties *PrivateLinkResourceProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

// PrivateLinkResourceListResult - The response of a PrivateLinkResource list operation.
type PrivateLinkResourceListResult struct {
	// REQUIRED; The PrivateLinkResource items on this page
	Value []*PrivateLinkResource

	// The link to the next page of items
	NextLink *string
}

// PrivateLinkResourceProperties - Properties of a private link resource.
type PrivateLinkResourceProperties struct {
	// The private link resource private link DNS zone name.
	RequiredZoneNames []*string

	// READ-ONLY; The private link resource group id.
	GroupID *string

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string
}

// PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer
// and provider.
type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string

	// The reason for approval/rejection of the connection.
	Description *string

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus
}

// PromoteReplicaRequest - Promote replica request properties.
type PromoteReplicaRequest struct {
	// REQUIRED; The promote option to apply to the operation.
	PromoteOption *PromoteOption

	// The mode to apply to the promote operation. Value is optional and default value is 'Switchover'.
	Mode *PromoteMode
}

// Properties - The properties of a mongo cluster.
type Properties struct {
	// The local administrator properties for the mongo cluster.
	Administrator *AdministratorProperties

	// The authentication configuration for the cluster.
	AuthConfig *AuthConfigProperties

	// The backup properties of the mongo cluster.
	Backup *BackupProperties

	// The compute properties of the mongo cluster.
	Compute *ComputeProperties

	// The mode to create a mongo cluster.
	CreateMode *CreateMode

	// The Data API properties of the mongo cluster.
	DataAPI *DataAPIProperties

	// The encryption configuration for the cluster. Depends on identity being configured.
	Encryption *EncryptionProperties

	// The high availability properties of the mongo cluster.
	HighAvailability *HighAvailabilityProperties

	// List of private endpoint connections.
	PreviewFeatures []*PreviewFeature

	// Whether or not public endpoint access is allowed for this mongo cluster.
	PublicNetworkAccess *PublicNetworkAccess

	// The parameters to create a replica mongo cluster.
	ReplicaParameters *ReplicaParameters

	// The parameters to create a point-in-time restore mongo cluster.
	RestoreParameters *RestoreParameters

	// The Mongo DB server version. Defaults to the latest available version if not specified.
	ServerVersion *string

	// The sharding properties of the mongo cluster.
	Sharding *ShardingProperties

	// The storage properties of the mongo cluster.
	Storage *StorageProperties

	// READ-ONLY; The status of the mongo cluster.
	ClusterStatus *Status

	// READ-ONLY; The default mongo connection string for the cluster.
	ConnectionString *string

	// READ-ONLY; The infrastructure version the cluster is provisioned on.
	InfrastructureVersion *string

	// READ-ONLY; List of private endpoint connections.
	PrivateEndpointConnections []*PrivateEndpointConnection

	// READ-ONLY; The provisioning state of the mongo cluster.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The replication properties for the mongo cluster
	Replica *ReplicationProperties
}

// Replica - Represents a mongo cluster replica.
type Replica struct {
	// The resource-specific properties for this resource.
	Properties *Properties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

// ReplicaListResult - The response of a Replica list operation.
type ReplicaListResult struct {
	// REQUIRED; The Replica items on this page
	Value []*Replica

	// The link to the next page of items
	NextLink *string
}

// ReplicaParameters - Parameters used for replica operations.
type ReplicaParameters struct {
	// REQUIRED; The location of the source cluster
	SourceLocation *string

	// REQUIRED; The id of the replication source cluster.
	SourceResourceID *string
}

// ReplicationProperties - Replica properties of the mongo cluster.
type ReplicationProperties struct {
	// READ-ONLY; The replication link state of the replica cluster.
	ReplicationState *ReplicationState

	// READ-ONLY; The replication role of the cluster
	Role *ReplicationRole

	// READ-ONLY; The resource id the source cluster for the replica cluster.
	SourceResourceID *string
}

// RestoreParameters - Parameters used for restore operations
type RestoreParameters struct {
	// UTC point in time to restore a mongo cluster
	PointInTimeUTC *time.Time

	// Resource ID to locate the source cluster to restore
	SourceResourceID *string
}

// ShardingProperties - The sharding properties of the cluster. This includes the shard count and scaling options for the
// cluster.
type ShardingProperties struct {
	// Number of shards to provision on the cluster.
	ShardCount *int32
}

// StorageProperties - The storage properties of the cluster. This includes the data storage size and scaling applied to servers
// in the cluster.
type StorageProperties struct {
	// The size of the data disk assigned to each server.
	SizeGb *int64

	// The type of storage to provision the cluster servers with.
	Type *StorageType
}

// SystemData - Metadata pertaining to creation and last modification of the resource.
type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

// Update - The type used for update operations of the MongoCluster.
type Update struct {
	// The managed service identities assigned to this resource.
	Identity *ManagedServiceIdentity

	// The resource-specific properties for this resource.
	Properties *UpdateProperties

	// Resource tags.
	Tags map[string]*string
}

// UpdateProperties - The updatable properties of the MongoCluster.
type UpdateProperties struct {
	// The local administrator properties for the mongo cluster.
	Administrator *AdministratorProperties

	// The authentication configuration for the cluster.
	AuthConfig *AuthConfigProperties

	// The backup properties of the mongo cluster.
	Backup *BackupProperties

	// The compute properties of the mongo cluster.
	Compute *ComputeProperties

	// The Data API properties of the mongo cluster.
	DataAPI *DataAPIProperties

	// The encryption configuration for the cluster. Depends on identity being configured.
	Encryption *EncryptionProperties

	// The high availability properties of the mongo cluster.
	HighAvailability *HighAvailabilityProperties

	// List of private endpoint connections.
	PreviewFeatures []*PreviewFeature

	// Whether or not public endpoint access is allowed for this mongo cluster.
	PublicNetworkAccess *PublicNetworkAccess

	// The Mongo DB server version. Defaults to the latest available version if not specified.
	ServerVersion *string

	// The sharding properties of the mongo cluster.
	Sharding *ShardingProperties

	// The storage properties of the mongo cluster.
	Storage *StorageProperties
}

// User - Represents a Mongo cluster user.
type User struct {
	// The resource-specific properties for this resource.
	Properties *UserProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

// UserAssignedIdentity - User assigned identity properties
type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string
}

// UserListResult - The response of a User list operation.
type UserListResult struct {
	// REQUIRED; The User items on this page
	Value []*User

	// The link to the next page of items
	NextLink *string
}

// UserProperties - Definition of Mongo user resource on a cluster.
type UserProperties struct {
	// The user's identity provider definition.
	IdentityProvider IdentityProviderClassification

	// Database roles that are assigned to the user.
	Roles []*DatabaseRole

	// READ-ONLY; The provisioning state of the user.
	ProvisioningState *ProvisioningState
}
