mirror of https://github.com/crossplane/docs.git
docs snapshot for crossplane version `master`
This commit is contained in:
parent
d940249050
commit
43c2270dbf
|
@ -86,7 +86,8 @@ API Group | Status | Details
|
|||
[`azure.crossplane.io/v1alpha3`] | Alpha | Core Azure resources.
|
||||
[`cache.azure.crossplane.io/v1beta1`] | Beta | Azure Redis managed resources and classes.
|
||||
[`compute.azure.crossplane.io/v1alpha3`] | Alpha | AKS managed resources and classes.
|
||||
[`database.azure.crossplane.io/v1alpha3`] | Alpha | Azure Database managed resources and classes.
|
||||
[`database.azure.crossplane.io/v1alpha3`] | Alpha | Azure Database Virtual Network Rule resources.
|
||||
[`database.azure.crossplane.io/v1beta1`] | Beta | Azure Database managed resources and classes.
|
||||
[`network.azure.crossplane.io/v1alpha3`] | Alpha | Virtual network managed resources and classes.
|
||||
[`storage.azure.crossplane.io/v1alpha3`] | Alpha | Azure Blob Storage managed resources and classes.
|
||||
|
||||
|
@ -94,6 +95,7 @@ API Group | Status | Details
|
|||
[`cache.azure.crossplane.io/v1beta1`]: api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1beta1.md
|
||||
[`compute.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/compute-azure-crossplane-io-v1alpha3.md
|
||||
[`database.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/database-azure-crossplane-io-v1alpha3.md
|
||||
[`database.azure.crossplane.io/v1beta1`]: api/crossplaneio/stack-azure/database-azure-crossplane-io-v1beta1.md
|
||||
[`network.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/network-azure-crossplane-io-v1alpha3.md
|
||||
[`storage.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/storage-azure-crossplane-io-v1alpha3.md
|
||||
|
||||
|
|
|
@ -1,29 +1,11 @@
|
|||
# database.azure.crossplane.io/v1alpha3 API Reference
|
||||
|
||||
Package v1alpha3 contains managed resources for Azure database services such as SQL server.
|
||||
Package v1alpha3 contains managed resources for Azure database services.
|
||||
|
||||
This API group contains the following Crossplane resources:
|
||||
|
||||
* [MySQLServer](#MySQLServer)
|
||||
* [MySQLServerVirtualNetworkRule](#MySQLServerVirtualNetworkRule)
|
||||
* [PostgreSQLServer](#PostgreSQLServer)
|
||||
* [PostgreSQLServerVirtualNetworkRule](#PostgreSQLServerVirtualNetworkRule)
|
||||
* [SQLServerClass](#SQLServerClass)
|
||||
|
||||
## MySQLServer
|
||||
|
||||
A MySQLServer is a managed resource that represents an Azure MySQL Database Server.
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`apiVersion` | string | `database.azure.crossplane.io/v1alpha3`
|
||||
`kind` | string | `MySQLServer`
|
||||
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
|
||||
`spec` | [SQLServerSpec](#SQLServerSpec) | A SQLServerSpec defines the desired state of a SQLServer.
|
||||
`status` | [SQLServerStatus](#SQLServerStatus) | A SQLServerStatus represents the observed state of a SQLServer.
|
||||
|
||||
|
||||
|
||||
## MySQLServerVirtualNetworkRule
|
||||
|
||||
|
@ -40,21 +22,6 @@ Name | Type | Description
|
|||
|
||||
|
||||
|
||||
## PostgreSQLServer
|
||||
|
||||
A PostgreSQLServer is a managed resource that represents an Azure PostgreSQL Database Server.
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`apiVersion` | string | `database.azure.crossplane.io/v1alpha3`
|
||||
`kind` | string | `PostgreSQLServer`
|
||||
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
|
||||
`spec` | [SQLServerSpec](#SQLServerSpec) | A SQLServerSpec defines the desired state of a SQLServer.
|
||||
`status` | [SQLServerStatus](#SQLServerStatus) | A SQLServerStatus represents the observed state of a SQLServer.
|
||||
|
||||
|
||||
|
||||
## PostgreSQLServerVirtualNetworkRule
|
||||
|
||||
A PostgreSQLServerVirtualNetworkRule is a managed resource that represents an Azure PostgreSQL Database virtual network rule.
|
||||
|
@ -70,37 +37,6 @@ Name | Type | Description
|
|||
|
||||
|
||||
|
||||
## SQLServerClass
|
||||
|
||||
A SQLServerClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`apiVersion` | string | `database.azure.crossplane.io/v1alpha3`
|
||||
`kind` | string | `SQLServerClass`
|
||||
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
|
||||
`specTemplate` | [SQLServerClassSpecTemplate](#SQLServerClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned SQLServer.
|
||||
|
||||
|
||||
|
||||
## MySQLServerNameReferencer
|
||||
|
||||
A MySQLServerNameReferencer returns the server name of a referenced MySQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [MySQLVirtualNetworkRuleSpec](#MySQLVirtualNetworkRuleSpec)
|
||||
* [ServerNameReferencerForMySQLServerVirtualNetworkRule](#ServerNameReferencerForMySQLServerVirtualNetworkRule)
|
||||
|
||||
|
||||
|
||||
|
||||
MySQLServerNameReferencer supports all fields of:
|
||||
|
||||
* [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core)
|
||||
|
||||
|
||||
## MySQLVirtualNetworkRuleSpec
|
||||
|
||||
A MySQLVirtualNetworkRuleSpec defines the desired state of a MySQLVirtualNetworkRule.
|
||||
|
@ -114,7 +50,7 @@ Name | Type | Description
|
|||
-----|------|------------
|
||||
`name` | string | Name - Name of the Virtual Network Rule.
|
||||
`serverName` | string | ServerName - Name of the Virtual Network Rule's server.
|
||||
`serverNameRef` | [MySQLServerNameReferencer](#MySQLServerNameReferencer) | ServerNameRef - A reference to the Virtual Network Rule's MySQLServer.
|
||||
`serverNameRef` | github.com/crossplaneio/stack-azure/apis/database/v1beta1.MySQLServerNameReferencer | ServerNameRef - A reference to the Virtual Network Rule's MySQLServer.
|
||||
`resourceGroupName` | string | ResourceGroupName - Name of the Virtual Network Rule's resource group.
|
||||
`resourceGroupNameRef` | [ResourceGroupNameReferencerForVirtualNetworkRule](#ResourceGroupNameReferencerForVirtualNetworkRule) | ResourceGroupNameRef - A reference to a ResourceGroup object to retrieve its name
|
||||
`properties` | [VirtualNetworkRuleProperties](#VirtualNetworkRuleProperties) | VirtualNetworkRuleProperties - Resource properties.
|
||||
|
@ -125,23 +61,6 @@ MySQLVirtualNetworkRuleSpec supports all fields of:
|
|||
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
|
||||
|
||||
|
||||
## PostgreSQLServerNameReferencer
|
||||
|
||||
A PostgreSQLServerNameReferencer returns the server name of a referenced PostgreSQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [PostgreSQLVirtualNetworkRuleSpec](#PostgreSQLVirtualNetworkRuleSpec)
|
||||
* [ServerNameReferencerForPostgreSQLServerVirtualNetworkRule](#ServerNameReferencerForPostgreSQLServerVirtualNetworkRule)
|
||||
|
||||
|
||||
|
||||
|
||||
PostgreSQLServerNameReferencer supports all fields of:
|
||||
|
||||
* [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core)
|
||||
|
||||
|
||||
## PostgreSQLVirtualNetworkRuleSpec
|
||||
|
||||
A PostgreSQLVirtualNetworkRuleSpec defines the desired state of a PostgreSQLVirtualNetworkRule.
|
||||
|
@ -155,7 +74,7 @@ Name | Type | Description
|
|||
-----|------|------------
|
||||
`name` | string | Name - Name of the Virtual Network Rule.
|
||||
`serverName` | string | ServerName - Name of the Virtual Network Rule's PostgreSQLServer.
|
||||
`serverNameRef` | [PostgreSQLServerNameReferencer](#PostgreSQLServerNameReferencer) | ServerNameRef - A reference to the Virtual Network Rule's PostgreSQLServer.
|
||||
`serverNameRef` | github.com/crossplaneio/stack-azure/apis/database/v1beta1.PostgreSQLServerNameReferencer | ServerNameRef - A reference to the Virtual Network Rule's PostgreSQLServer.
|
||||
`resourceGroupName` | string | ResourceGroupName - Name of the Virtual Network Rule's resource group.
|
||||
`resourceGroupNameRef` | [ResourceGroupNameReferencerForVirtualNetworkRule](#ResourceGroupNameReferencerForVirtualNetworkRule) | ResourceGroupNameRef - A reference to a ResourceGroup object to retrieve its name
|
||||
`properties` | [VirtualNetworkRuleProperties](#VirtualNetworkRuleProperties) | VirtualNetworkRuleProperties - Resource properties.
|
||||
|
@ -166,39 +85,6 @@ PostgreSQLVirtualNetworkRuleSpec supports all fields of:
|
|||
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
|
||||
|
||||
|
||||
## PricingTierSpec
|
||||
|
||||
PricingTierSpec represents the performance and cost oriented properties of a SQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`tier` | string | Tier of the particular SKU, e.g. Basic. Possible values include: 'Basic', 'GeneralPurpose', 'MemoryOptimized'
|
||||
`vcores` | int | VCores (aka Capacity) specifies how many virtual cores this SQLServer requires.
|
||||
`family` | string | Family of hardware.
|
||||
|
||||
|
||||
|
||||
## ResourceGroupNameReferencerForSQLServer
|
||||
|
||||
ResourceGroupNameReferencerForSQLServer is an attribute referencer that resolves the name of a the ResourceGroup.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
|
||||
|
||||
ResourceGroupNameReferencerForSQLServer supports all fields of:
|
||||
|
||||
* github.com/crossplaneio/stack-azure/apis/v1alpha3.ResourceGroupNameReferencer
|
||||
|
||||
|
||||
## ResourceGroupNameReferencerForVirtualNetworkRule
|
||||
|
||||
ResourceGroupNameReferencerForVirtualNetworkRule is an attribute referencer that resolves the name of a the ResourceGroup.
|
||||
|
@ -216,87 +102,6 @@ ResourceGroupNameReferencerForVirtualNetworkRule supports all fields of:
|
|||
* github.com/crossplaneio/stack-azure/apis/v1alpha3.ResourceGroupNameReferencer
|
||||
|
||||
|
||||
## SQLServerClassSpecTemplate
|
||||
|
||||
A SQLServerClassSpecTemplate is a template for the spec of a dynamically provisioned MySQLServer or PostgreSQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerClass](#SQLServerClass)
|
||||
|
||||
|
||||
|
||||
|
||||
SQLServerClassSpecTemplate supports all fields of:
|
||||
|
||||
* [v1alpha1.ClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#classspectemplate)
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
## SQLServerParameters
|
||||
|
||||
SQLServerParameters define the desired state of an Azure SQL Database, either PostgreSQL or MySQL.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerClassSpecTemplate](#SQLServerClassSpecTemplate)
|
||||
* [SQLServerSpec](#SQLServerSpec)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`resourceGroupName` | string | ResourceGroupName specifies the name of the resource group that should contain this SQLServer.
|
||||
`resourceGroupNameRef` | [ResourceGroupNameReferencerForSQLServer](#ResourceGroupNameReferencerForSQLServer) | ResourceGroupNameRef - A reference to a ResourceGroup object to retrieve its name
|
||||
`location` | string | Location specifies the location of this SQLServer.
|
||||
`pricingTier` | [PricingTierSpec](#PricingTierSpec) | PricingTier specifies the pricing tier (aka SKU) for this SQLServer.
|
||||
`storageProfile` | [StorageProfileSpec](#StorageProfileSpec) | StorageProfile configures the storage profile of this SQLServer.
|
||||
`adminLoginName` | string | AdminLoginName specifies the administrator login name for this SQLServer.
|
||||
`version` | string | Version specifies the version of this server, for example "5.6", or "9.6".
|
||||
`sslEnforced` | Optional bool | SSLEnforced specifies whether SSL is required to connect to this SQLServer.
|
||||
|
||||
|
||||
|
||||
## SQLServerSpec
|
||||
|
||||
A SQLServerSpec defines the desired state of a SQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [MySQLServer](#MySQLServer)
|
||||
* [PostgreSQLServer](#PostgreSQLServer)
|
||||
|
||||
|
||||
|
||||
|
||||
SQLServerSpec supports all fields of:
|
||||
|
||||
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
## SQLServerStatus
|
||||
|
||||
A SQLServerStatus represents the observed state of a SQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [MySQLServer](#MySQLServer)
|
||||
* [PostgreSQLServer](#PostgreSQLServer)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`state` | string | State of this SQLServer.
|
||||
`message` | string | A Message containing detail on the state of this SQLServer, if any.
|
||||
`providerID` | string | ProviderID is the external ID to identify this resource in the cloud provider.
|
||||
`endpoint` | string | Endpoint of the MySQL Server instance used in connection strings.
|
||||
|
||||
|
||||
SQLServerStatus supports all fields of:
|
||||
|
||||
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
|
||||
|
||||
|
||||
## ServerNameReferencerForMySQLServerVirtualNetworkRule
|
||||
|
||||
ServerNameReferencerForMySQLServerVirtualNetworkRule is an attribute referencer that resolves the name of a MySQLServer.
|
||||
|
@ -306,7 +111,7 @@ ServerNameReferencerForMySQLServerVirtualNetworkRule is an attribute referencer
|
|||
|
||||
ServerNameReferencerForMySQLServerVirtualNetworkRule supports all fields of:
|
||||
|
||||
* [MySQLServerNameReferencer](#MySQLServerNameReferencer)
|
||||
* github.com/crossplaneio/stack-azure/apis/database/v1beta1.MySQLServerNameReferencer
|
||||
|
||||
|
||||
## ServerNameReferencerForPostgreSQLServerVirtualNetworkRule
|
||||
|
@ -318,24 +123,7 @@ ServerNameReferencerForPostgreSQLServerVirtualNetworkRule is an attribute refere
|
|||
|
||||
ServerNameReferencerForPostgreSQLServerVirtualNetworkRule supports all fields of:
|
||||
|
||||
* [PostgreSQLServerNameReferencer](#PostgreSQLServerNameReferencer)
|
||||
|
||||
|
||||
## StorageProfileSpec
|
||||
|
||||
A StorageProfileSpec represents storage related properties of a SQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`storageGB` | int | StorageGB configures the maximum storage allowed.
|
||||
`backupRetentionDays` | int | BackupRetentionDays configures how many days backups will be retained.
|
||||
`geoRedundantBackup` | bool | GeoRedundantBackup enables geo-redunndant backups.
|
||||
|
||||
* github.com/crossplaneio/stack-azure/apis/database/v1beta1.PostgreSQLServerNameReferencer
|
||||
|
||||
|
||||
## SubnetIDReferencerForVirtualNetworkRule
|
||||
|
|
|
@ -0,0 +1,234 @@
|
|||
# database.azure.crossplane.io/v1beta1 API Reference
|
||||
|
||||
Package v1beta1 contains managed resources for Azure database services such as SQL server.
|
||||
|
||||
This API group contains the following Crossplane resources:
|
||||
|
||||
* [MySQLServer](#MySQLServer)
|
||||
* [PostgreSQLServer](#PostgreSQLServer)
|
||||
* [SQLServerClass](#SQLServerClass)
|
||||
|
||||
## MySQLServer
|
||||
|
||||
A MySQLServer is a managed resource that represents an Azure MySQL Database Server.
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`apiVersion` | string | `database.azure.crossplane.io/v1beta1`
|
||||
`kind` | string | `MySQLServer`
|
||||
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
|
||||
`spec` | [SQLServerSpec](#SQLServerSpec) | A SQLServerSpec defines the desired state of a SQLServer.
|
||||
`status` | [SQLServerStatus](#SQLServerStatus) | A SQLServerStatus represents the observed state of a SQLServer.
|
||||
|
||||
|
||||
|
||||
## PostgreSQLServer
|
||||
|
||||
A PostgreSQLServer is a managed resource that represents an Azure PostgreSQL Database Server.
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`apiVersion` | string | `database.azure.crossplane.io/v1beta1`
|
||||
`kind` | string | `PostgreSQLServer`
|
||||
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
|
||||
`spec` | [SQLServerSpec](#SQLServerSpec) | A SQLServerSpec defines the desired state of a SQLServer.
|
||||
`status` | [SQLServerStatus](#SQLServerStatus) | A SQLServerStatus represents the observed state of a SQLServer.
|
||||
|
||||
|
||||
|
||||
## SQLServerClass
|
||||
|
||||
A SQLServerClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`apiVersion` | string | `database.azure.crossplane.io/v1beta1`
|
||||
`kind` | string | `SQLServerClass`
|
||||
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
|
||||
`specTemplate` | [SQLServerClassSpecTemplate](#SQLServerClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned SQLServer.
|
||||
|
||||
|
||||
|
||||
## MySQLServerNameReferencer
|
||||
|
||||
A MySQLServerNameReferencer returns the server name of a referenced MySQLServer.
|
||||
|
||||
|
||||
|
||||
|
||||
MySQLServerNameReferencer supports all fields of:
|
||||
|
||||
* [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core)
|
||||
|
||||
|
||||
## PostgreSQLServerNameReferencer
|
||||
|
||||
A PostgreSQLServerNameReferencer returns the server name of a referenced PostgreSQLServer.
|
||||
|
||||
|
||||
|
||||
|
||||
PostgreSQLServerNameReferencer supports all fields of:
|
||||
|
||||
* [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core)
|
||||
|
||||
|
||||
## ResourceGroupNameReferencerForSQLServer
|
||||
|
||||
ResourceGroupNameReferencerForSQLServer is an attribute referencer that resolves the name of a the ResourceGroup.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
|
||||
|
||||
ResourceGroupNameReferencerForSQLServer supports all fields of:
|
||||
|
||||
* github.com/crossplaneio/stack-azure/apis/v1alpha3.ResourceGroupNameReferencer
|
||||
|
||||
|
||||
## SKU
|
||||
|
||||
SKU billing information related properties of a server.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`tier` | string | Tier - The tier of the particular SKU. Possible values include: 'Basic', 'GeneralPurpose', 'MemoryOptimized'
|
||||
`capacity` | int | Capacity - The scale up/out capacity, representing server's compute units.
|
||||
`size` | Optional string | Size - The size code, to be interpreted by resource as appropriate.
|
||||
`family` | string | Family - The family of hardware.
|
||||
|
||||
|
||||
|
||||
## SQLServerClassSpecTemplate
|
||||
|
||||
A SQLServerClassSpecTemplate is a template for the spec of a dynamically provisioned MySQLServer or PostgreSQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerClass](#SQLServerClass)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`forProvider` | [SQLServerParameters](#SQLServerParameters) | SQLServerParameters define the desired state of an Azure SQL Database, either PostgreSQL or MySQL.
|
||||
|
||||
|
||||
SQLServerClassSpecTemplate supports all fields of:
|
||||
|
||||
* [v1alpha1.ClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#classspectemplate)
|
||||
|
||||
|
||||
## SQLServerObservation
|
||||
|
||||
SQLServerObservation represents the current state of Azure SQL resource.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerStatus](#SQLServerStatus)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`id` | string | ID - Resource ID
|
||||
`name` | string | Name - Resource name.
|
||||
`type` | string | Type - Resource type.
|
||||
`userVisibleState` | string | UserVisibleState - A state of a server that is visible to user.
|
||||
`fullyQualifiedDomainName` | string | FullyQualifiedDomainName - The fully qualified domain name of a server.
|
||||
`masterServerId` | string | MasterServerID - The master server id of a replica server.
|
||||
|
||||
|
||||
|
||||
## SQLServerParameters
|
||||
|
||||
SQLServerParameters define the desired state of an Azure SQL Database, either PostgreSQL or MySQL.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerClassSpecTemplate](#SQLServerClassSpecTemplate)
|
||||
* [SQLServerSpec](#SQLServerSpec)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`resourceGroupName` | string | ResourceGroupName specifies the name of the resource group that should contain this SQLServer.
|
||||
`resourceGroupNameRef` | [ResourceGroupNameReferencerForSQLServer](#ResourceGroupNameReferencerForSQLServer) | ResourceGroupNameRef - A reference to a ResourceGroup object to retrieve its name
|
||||
`sku` | [SKU](#SKU) | SKU is the billing information related properties of the server.
|
||||
`location` | string | Location specifies the location of this SQLServer.
|
||||
`administratorLogin` | string | AdministratorLogin - The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
|
||||
`tags` | Optional map[string]string | Tags - Application-specific metadata in the form of key-value pairs.
|
||||
`version` | string | Version - Server version.
|
||||
`sslEnforcement` | string | SSLEnforcement - Enable ssl enforcement or not when connect to server. Possible values include: 'Enabled', 'Disabled'
|
||||
`storageProfile` | [StorageProfile](#StorageProfile) | StorageProfile - Storage profile of a server.
|
||||
|
||||
|
||||
|
||||
## SQLServerSpec
|
||||
|
||||
A SQLServerSpec defines the desired state of a SQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [MySQLServer](#MySQLServer)
|
||||
* [PostgreSQLServer](#PostgreSQLServer)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`forProvider` | [SQLServerParameters](#SQLServerParameters) | SQLServerParameters define the desired state of an Azure SQL Database, either PostgreSQL or MySQL.
|
||||
|
||||
|
||||
SQLServerSpec supports all fields of:
|
||||
|
||||
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
|
||||
|
||||
|
||||
## SQLServerStatus
|
||||
|
||||
A SQLServerStatus represents the observed state of a SQLServer.
|
||||
|
||||
Appears in:
|
||||
|
||||
* [MySQLServer](#MySQLServer)
|
||||
* [PostgreSQLServer](#PostgreSQLServer)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`atProvider` | [SQLServerObservation](#SQLServerObservation) | SQLServerObservation represents the current state of Azure SQL resource.
|
||||
|
||||
|
||||
SQLServerStatus supports all fields of:
|
||||
|
||||
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
|
||||
|
||||
|
||||
## StorageProfile
|
||||
|
||||
StorageProfile storage Profile properties of a server
|
||||
|
||||
Appears in:
|
||||
|
||||
* [SQLServerParameters](#SQLServerParameters)
|
||||
|
||||
|
||||
Name | Type | Description
|
||||
-----|------|------------
|
||||
`backupRetentionDays` | Optional int | BackupRetentionDays - Backup retention days for the server.
|
||||
`geoRedundantBackup` | Optional string | GeoRedundantBackup - Enable Geo-redundant or not for server backup. Possible values include: 'Enabled', 'Disabled'
|
||||
`storageMB` | int | StorageMB - Max storage allowed for a server.
|
||||
`storageAutogrow` | Optional string | StorageAutogrow - Enable Storage Auto Grow. Possible values include: 'Enabled', 'Disabled'
|
||||
|
||||
|
||||
|
||||
This API documentation was generated by `crossdocs`.
|
|
@ -114,7 +114,7 @@ an [Azure Database for MySQL][azure-mysql] instance.
|
|||
```yaml
|
||||
cat > azure-mysql-standard.yaml <<EOF
|
||||
---
|
||||
apiVersion: database.azure.crossplane.io/v1alpha3
|
||||
apiVersion: database.azure.crossplane.io/v1beta1
|
||||
kind: SQLServerClass
|
||||
metadata:
|
||||
name: azure-mysql-standard
|
||||
|
@ -122,19 +122,18 @@ metadata:
|
|||
size: standard
|
||||
demo: "true"
|
||||
specTemplate:
|
||||
adminLoginName: myadmin
|
||||
resourceGroupName: $AKS_RESOURCE_GROUP
|
||||
location: $AKS_REGION
|
||||
sslEnforced: false
|
||||
version: "5.6"
|
||||
pricingTier:
|
||||
tier: GeneralPurpose
|
||||
vcores: 2
|
||||
family: Gen5
|
||||
storageProfile:
|
||||
storageGB: 25
|
||||
backupRetentionDays: 7
|
||||
geoRedundantBackup: false
|
||||
forProvider:
|
||||
administratorLogin: myadmin
|
||||
resourceGroupName: $AKS_RESOURCE_GROUP
|
||||
location: $AKS_REGION
|
||||
sslEnforcement: Disabled
|
||||
version: "5.6"
|
||||
sku:
|
||||
tier: GeneralPurpose
|
||||
capacity: 2
|
||||
family: Gen5
|
||||
storageProfile:
|
||||
storageMB: 25600
|
||||
writeConnectionSecretsToNamespace: crossplane-system
|
||||
providerRef:
|
||||
name: azure-provider
|
||||
|
@ -240,7 +239,7 @@ Metadata:
|
|||
UID: afff42b3-f999-11e9-a2d5-c64d758a651f
|
||||
Spec:
|
||||
Class Ref:
|
||||
API Version: database.azure.crossplane.io/v1alpha3
|
||||
API Version: database.azure.crossplane.io/v1beta1
|
||||
Kind: SQLServerClass
|
||||
Name: azure-mysql-standard
|
||||
UID: 5710f3db-f999-11e9-a2d5-c64d758a651f
|
||||
|
@ -250,7 +249,7 @@ Spec:
|
|||
Size: standard
|
||||
Engine Version: 5.6
|
||||
Resource Ref:
|
||||
API Version: database.azure.crossplane.io/v1alpha3
|
||||
API Version: database.azure.crossplane.io/v1beta1
|
||||
Kind: MySQLServer
|
||||
Name: default-mysql-claim-bm4ft
|
||||
UID: b02c1389-f999-11e9-a2d5-c64d758a651f
|
||||
|
|
|
@ -294,28 +294,27 @@ Below we inspect each of these resource classes in more details:
|
|||
|
||||
```yaml
|
||||
---
|
||||
apiVersion: database.azure.crossplane.io/v1alpha3
|
||||
apiVersion: database.azure.crossplane.io/v1beta1
|
||||
kind: SQLServerClass
|
||||
metadata:
|
||||
name: standard-mysql
|
||||
annotations:
|
||||
resourceclass.crossplane.io/is-default-class: "true"
|
||||
specTemplate:
|
||||
forProvider:
|
||||
administratorLogin: my-cool-login
|
||||
resourceGroupNameRef:
|
||||
name: sample-rg
|
||||
location: Central US
|
||||
sslEnforcement: Disabled
|
||||
version: "5.6"
|
||||
sku:
|
||||
tier: GeneralPurpose
|
||||
capacity: 2
|
||||
family: Gen5
|
||||
storageProfile:
|
||||
storageMB: 25600
|
||||
writeConnectionSecretsToNamespace: crossplane-system
|
||||
adminLoginName: my-cool-login
|
||||
resourceGroupNameRef:
|
||||
name: sample-rg
|
||||
location: Central US
|
||||
sslEnforced: false
|
||||
version: "5.6"
|
||||
pricingTier:
|
||||
tier: GeneralPurpose
|
||||
vcores: 2
|
||||
family: Gen5
|
||||
storageProfile:
|
||||
storageGB: 25
|
||||
backupRetentionDays: 7
|
||||
geoRedundantBackup: false
|
||||
reclaimPolicy: Delete
|
||||
providerRef:
|
||||
name: azure-provider
|
||||
|
|
Loading…
Reference in New Issue