v1alpha1
| Metadata | Value |
|---|---|
| Group | infrastructure.cluster.x-k8s.io |
| Version | |
| Module | sigs.k8s.io/cluster-api-provider-azure/api/v1alpha1 |
| Property Optionality |
AzureASOManagedCluster
AzureASOManagedCluster is the Schema for the azureasomanagedclusters API.
Used by: AzureASOManagedClusterList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureASOManagedClusterSpec | |
| status | AzureASOManagedClusterStatus |
AzureASOManagedClusterSpec
| Property | Description | Type |
|---|---|---|
| AzureASOManagedClusterTemplateResourceSpec | ||
| controlPlaneEndpoint | ControlPlaneEndpoint is the location of the API server within the control plane. CAPZ manages this field and it should not be set by the user. It fulfills Cluster API's cluster infrastructure provider contract. Because this field is programmatically set by CAPZ after resource creation, we define it as +optional in the API schema to permit resource admission. | clusterv1.APIEndpoint |
AzureASOManagedClusterStatus
| Property | Description | Type |
|---|---|---|
| ready | Ready represents whether or not the cluster has been provisioned and is ready. It fulfills Cluster API's cluster infrastructure provider contract. | bool |
| resources | ResourceStatus[] |
AzureASOManagedClusterList
AzureASOManagedClusterList contains a list of AzureASOManagedCluster.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureASOManagedCluster[] |
AzureASOManagedClusterTemplate
AzureASOManagedClusterTemplate is the Schema for the azureasomanagedclustertemplates API.
Used by: AzureASOManagedClusterTemplateList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureASOManagedClusterTemplateSpec |
AzureASOManagedClusterTemplateList
AzureASOManagedClusterTemplateList contains a list of AzureASOManagedClusterTemplate.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureASOManagedClusterTemplate[] |
AzureASOManagedClusterTemplateResource
AzureASOManagedClusterTemplateResource defines the templated resource.
Used by: AzureASOManagedClusterTemplateSpec.
| Property | Description | Type |
|---|---|---|
| spec | AzureASOManagedClusterTemplateResourceSpec |
AzureASOManagedClusterTemplateResourceSpec
AzureASOManagedClusterTemplateResourceSpec defines the desired state of the templated resource.
Used by: AzureASOManagedClusterTemplateResource.
| Property | Description | Type |
|---|---|---|
| resources | Resources are embedded ASO resources to be managed by this resource. | runtime.RawExtension[] |
AzureASOManagedClusterTemplateSpec
AzureASOManagedClusterTemplateSpec defines the desired state of AzureASOManagedClusterTemplate.
Used by: AzureASOManagedClusterTemplate.
| Property | Description | Type |
|---|---|---|
| template | AzureASOManagedClusterTemplateResource |
AzureASOManagedControlPlane
AzureASOManagedControlPlane is the Schema for the azureasomanagedcontrolplanes API.
Used by: AzureASOManagedControlPlaneList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureASOManagedControlPlaneSpec | |
| status | AzureASOManagedControlPlaneStatus |
AzureASOManagedControlPlaneSpec
AzureASOManagedControlPlaneStatus
| Property | Description | Type |
|---|---|---|
| controlPlaneEndpoint | ControlPlaneEndpoint represents the endpoint for the cluster's API server. | clusterv1.APIEndpoint |
| initialized | Initialized represents whether or not the API server has been provisioned. It fulfills Cluster API's control plane provider contract. For AKS, this is equivalent to ready. | bool |
| ready | Ready represents whether or not the API server is ready to receive requests. It fulfills Cluster API's control plane provider contract. For AKS, this is equivalent to initialized. | bool |
| resources | ResourceStatus[] | |
| version | Version is the observed Kubernetes version of the control plane. It fulfills Cluster API's control plane provider contract. | string |
AzureASOManagedControlPlaneList
AzureASOManagedControlPlaneList contains a list of AzureASOManagedControlPlane.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureASOManagedControlPlane[] |
AzureASOManagedControlPlaneResource
AzureASOManagedControlPlaneResource defines the templated resource.
Used by: AzureASOManagedControlPlaneTemplateSpec, and AzureASOManagedMachinePoolTemplateSpec.
| Property | Description | Type |
|---|---|---|
| spec | AzureASOManagedControlPlaneTemplateResourceSpec |
AzureASOManagedControlPlaneTemplate
AzureASOManagedControlPlaneTemplate is the Schema for the azureasomanagedcontrolplanetemplates API.
Used by: AzureASOManagedControlPlaneTemplateList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureASOManagedControlPlaneTemplateSpec |
AzureASOManagedControlPlaneTemplateList
AzureASOManagedControlPlaneTemplateList contains a list of AzureASOManagedControlPlaneTemplate.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureASOManagedControlPlaneTemplate[] |
AzureASOManagedControlPlaneTemplateResourceSpec
AzureASOManagedControlPlaneTemplateResourceSpec defines the desired state of the templated resource.
Used by: AzureASOManagedControlPlaneResource.
| Property | Description | Type |
|---|---|---|
| resources | Resources are embedded ASO resources to be managed by this resource. | runtime.RawExtension[] |
| version | Version is the Kubernetes version of the control plane. It fulfills Cluster API's control plane provider contract. | string |
AzureASOManagedControlPlaneTemplateSpec
AzureASOManagedControlPlaneTemplateSpec defines the desired state of AzureASOManagedControlPlane.
Used by: AzureASOManagedControlPlaneTemplate.
| Property | Description | Type |
|---|---|---|
| template | AzureASOManagedControlPlaneResource |
AzureASOManagedMachinePool
AzureASOManagedMachinePool is the Schema for the azureasomanagedmachinepools API.
Used by: AzureASOManagedMachinePoolList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureASOManagedMachinePoolSpec | |
| status | AzureASOManagedMachinePoolStatus |
AzureASOManagedMachinePoolSpec
AzureASOManagedMachinePoolStatus
| Property | Description | Type |
|---|---|---|
| ready | Ready represents whether or not the infrastructure is ready to be used. It fulfills Cluster API's machine pool infrastructure provider contract. | bool |
| replicas | Replicas is the current number of provisioned replicas. It fulfills Cluster API's machine pool infrastructure provider contract. | int32 |
| resources | ResourceStatus[] |
AzureASOManagedMachinePoolList
AzureASOManagedMachinePoolList contains a list of AzureASOManagedMachinePool.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureASOManagedMachinePool[] |
AzureASOManagedMachinePoolResource
AzureASOManagedMachinePoolResource defines the templated resource.
| Property | Description | Type |
|---|---|---|
| spec | AzureASOManagedMachinePoolTemplateResourceSpec |
AzureASOManagedMachinePoolTemplate
AzureASOManagedMachinePoolTemplate is the Schema for the azureasomanagedmachinepooltemplates API.
Used by: AzureASOManagedMachinePoolTemplateList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureASOManagedMachinePoolTemplateSpec |
AzureASOManagedMachinePoolTemplateList
AzureASOManagedMachinePoolTemplateList contains a list of AzureASOManagedMachinePoolTemplate.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureASOManagedMachinePoolTemplate[] |
AzureASOManagedMachinePoolTemplateResourceSpec
AzureASOManagedMachinePoolTemplateResourceSpec defines the desired state of the templated resource.
Used by: AzureASOManagedMachinePoolResource.
| Property | Description | Type |
|---|---|---|
| providerIDList | ProviderIDList is the list of cloud provider IDs for the instances. It fulfills Cluster API's machine pool infrastructure provider contract. | string[] |
| resources | Resources are embedded ASO resources to be managed by this resource. | runtime.RawExtension[] |
AzureASOManagedMachinePoolTemplateSpec
AzureASOManagedMachinePoolTemplateSpec defines the desired state of AzureASOManagedMachinePoolTemplate.
Used by: AzureASOManagedMachinePoolTemplate.
| Property | Description | Type |
|---|---|---|
| template | AzureASOManagedControlPlaneResource |
AzureASOManagedClusterSpec
AzureASOManagedClusterSpec defines the desired state of AzureASOManagedCluster.
Used by: AzureASOManagedCluster.
| Property | Description | Type |
|---|---|---|
| AzureASOManagedClusterTemplateResourceSpec | ||
| controlPlaneEndpoint | ControlPlaneEndpoint is the location of the API server within the control plane. CAPZ manages this field and it should not be set by the user. It fulfills Cluster API's cluster infrastructure provider contract. Because this field is programmatically set by CAPZ after resource creation, we define it as +optional in the API schema to permit resource admission. | clusterv1.APIEndpoint |
AzureASOManagedClusterStatus
AzureASOManagedClusterStatus defines the observed state of AzureASOManagedCluster.
Used by: AzureASOManagedCluster.
| Property | Description | Type |
|---|---|---|
| ready | Ready represents whether or not the cluster has been provisioned and is ready. It fulfills Cluster API's cluster infrastructure provider contract. | bool |
| resources | ResourceStatus[] |
AzureASOManagedControlPlaneSpec
AzureASOManagedControlPlaneSpec defines the desired state of AzureASOManagedControlPlane.
Used by: AzureASOManagedControlPlane.
AzureASOManagedControlPlaneStatus
AzureASOManagedControlPlaneStatus defines the observed state of AzureASOManagedControlPlane.
Used by: AzureASOManagedControlPlane.
| Property | Description | Type |
|---|---|---|
| controlPlaneEndpoint | ControlPlaneEndpoint represents the endpoint for the cluster's API server. | clusterv1.APIEndpoint |
| initialized | Initialized represents whether or not the API server has been provisioned. It fulfills Cluster API's control plane provider contract. For AKS, this is equivalent to ready. | bool |
| ready | Ready represents whether or not the API server is ready to receive requests. It fulfills Cluster API's control plane provider contract. For AKS, this is equivalent to initialized. | bool |
| resources | ResourceStatus[] | |
| version | Version is the observed Kubernetes version of the control plane. It fulfills Cluster API's control plane provider contract. | string |
AzureASOManagedMachinePoolSpec
AzureASOManagedMachinePoolSpec defines the desired state of AzureASOManagedMachinePool.
Used by: AzureASOManagedMachinePool.
AzureASOManagedMachinePoolStatus
AzureASOManagedMachinePoolStatus defines the observed state of AzureASOManagedMachinePool.
Used by: AzureASOManagedMachinePool.
| Property | Description | Type |
|---|---|---|
| ready | Ready represents whether or not the infrastructure is ready to be used. It fulfills Cluster API's machine pool infrastructure provider contract. | bool |
| replicas | Replicas is the current number of provisioned replicas. It fulfills Cluster API's machine pool infrastructure provider contract. | int32 |
| resources | ResourceStatus[] |
ResourceStatus
ResourceStatus represents the status of a resource.
Used by: AzureASOManagedClusterStatus, AzureASOManagedControlPlaneStatus, and AzureASOManagedMachinePoolStatus.
| Property | Description | Type |
|---|---|---|
| ready | bool | |
| resource | StatusResource |
StatusResource
StatusResource is a handle to a resource.
Used by: ResourceStatus.
| Property | Description | Type |
|---|---|---|
| group | string | |
| kind | string | |
| name | string | |
| version | string |