Skip to content

XSubscription

API

Property Value
Group azure.platform.example.org
Kind XSubscription
Plural xsubscriptions
Scope Namespaced
Versions v1alpha1 (referenceable)
Source compositions/apis/azure/subscription/schema.yaml

Spec

Field Type Required Default Description
managementGroupId string yes — Constraints: pattern: ^/providers/Microsoft.Management/managementGroups/[^/]+$.
name immutable string yes — Logical attachment name; does not create a subscription. Constraints: minLength: 1, maxLength: 40, pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$.
providerConfigRef object no {} —
    providerConfigRef.kind string no ClusterProviderConfig One of: ProviderConfig, ClusterProviderConfig.
    providerConfigRef.name string no default Constraints: minLength: 1.
subscriptionId immutable string yes — Constraints: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$.

Fields marked immutable are fixed once the resource is created; changing one is rejected by the API server. An immutable object pins the fields nested under it too. To change one, delete the resource and create it again.

Status

Populated by Crossplane once the underlying Azure resources exist. Every composite in this repository exposes the provisioned Azure resource ID as status.id.

Field Type Required Default Description
associationId string no — Observed management-group association ARM ID.
id string no — Existing subscription ARM ID, not an owned subscription.
managedResourceName string no — —

Reference