v1beta2

package
v1.6.0 Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=invitations.azuread.upbound.io +versionName=v1beta2

Index

Constants

View Source
const (
	CRDGroup   = "invitations.azuread.upbound.io"
	CRDVersion = "v1beta2"
)

Package type metadata.

Variables

View Source
var (
	// CRDGroupVersion is the API Group Version used to register the objects
	CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var (
	Invitation_Kind             = "Invitation"
	Invitation_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Invitation_Kind}.String()
	Invitation_KindAPIVersion   = Invitation_Kind + "." + CRDGroupVersion.String()
	Invitation_GroupVersionKind = CRDGroupVersion.WithKind(Invitation_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type Invitation

type Invitation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.redirectUrl) || (has(self.initProvider) && has(self.initProvider.redirectUrl))",message="spec.forProvider.redirectUrl is a required parameter"
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.userEmailAddress) || (has(self.initProvider) && has(self.initProvider.userEmailAddress))",message="spec.forProvider.userEmailAddress is a required parameter"
	Spec   InvitationSpec   `json:"spec"`
	Status InvitationStatus `json:"status,omitempty"`
}

Invitation is the Schema for the Invitations API. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,azuread}

func (*Invitation) DeepCopy

func (in *Invitation) DeepCopy() *Invitation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Invitation.

func (*Invitation) DeepCopyInto

func (in *Invitation) DeepCopyInto(out *Invitation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Invitation) DeepCopyObject

func (in *Invitation) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Invitation) GetCondition

func (mg *Invitation) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Invitation.

func (*Invitation) GetConnectionDetailsMapping

func (tr *Invitation) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this Invitation

func (*Invitation) GetDeletionPolicy

func (mg *Invitation) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Invitation.

func (*Invitation) GetID

func (tr *Invitation) GetID() string

GetID returns ID of underlying Terraform resource of this Invitation

func (*Invitation) GetInitParameters

func (tr *Invitation) GetInitParameters() (map[string]any, error)

GetInitParameters of this Invitation

func (*Invitation) GetManagementPolicies

func (mg *Invitation) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Invitation.

func (*Invitation) GetMergedParameters

func (tr *Invitation) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)

GetInitParameters of this Invitation

func (*Invitation) GetObservation

func (tr *Invitation) GetObservation() (map[string]any, error)

GetObservation of this Invitation

func (*Invitation) GetParameters

func (tr *Invitation) GetParameters() (map[string]any, error)

GetParameters of this Invitation

func (*Invitation) GetProviderConfigReference

func (mg *Invitation) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Invitation.

func (*Invitation) GetPublishConnectionDetailsTo

func (mg *Invitation) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Invitation.

func (*Invitation) GetTerraformResourceType

func (mg *Invitation) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Invitation

func (*Invitation) GetTerraformSchemaVersion

func (tr *Invitation) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Invitation) GetWriteConnectionSecretToReference

func (mg *Invitation) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Invitation.

func (*Invitation) Hub

func (tr *Invitation) Hub()

Hub marks this type as a conversion hub.

func (*Invitation) LateInitialize

func (tr *Invitation) LateInitialize(attrs []byte) (bool, error)

LateInitialize this Invitation using its observed tfState. returns True if there are any spec changes for the resource.

func (*Invitation) SetConditions

func (mg *Invitation) SetConditions(c ...xpv1.Condition)

SetConditions of this Invitation.

func (*Invitation) SetDeletionPolicy

func (mg *Invitation) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Invitation.

func (*Invitation) SetManagementPolicies

func (mg *Invitation) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Invitation.

func (*Invitation) SetObservation

func (tr *Invitation) SetObservation(obs map[string]any) error

SetObservation for this Invitation

func (*Invitation) SetParameters

func (tr *Invitation) SetParameters(params map[string]any) error

SetParameters for this Invitation

func (*Invitation) SetProviderConfigReference

func (mg *Invitation) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this Invitation.

func (*Invitation) SetPublishConnectionDetailsTo

func (mg *Invitation) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this Invitation.

func (*Invitation) SetWriteConnectionSecretToReference

func (mg *Invitation) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this Invitation.

type InvitationInitParameters

type InvitationInitParameters struct {

	// A message block as documented below, which configures the message being sent to the invited user. If this block is omitted, no message will be sent.
	// Customize the message sent to the invited user
	Message *MessageInitParameters `json:"message,omitempty" tf:"message,omitempty"`

	// The URL that the user should be redirected to once the invitation is redeemed.
	// The URL that the user should be redirected to once the invitation is redeemed
	RedirectURL *string `json:"redirectUrl,omitempty" tf:"redirect_url,omitempty"`

	// The display name of the user being invited.
	// The display name of the user being invited
	UserDisplayName *string `json:"userDisplayName,omitempty" tf:"user_display_name,omitempty"`

	// The email address of the user being invited.
	// The email address of the user being invited
	UserEmailAddress *string `json:"userEmailAddress,omitempty" tf:"user_email_address,omitempty"`

	// The user type of the user being invited. Must be one of Guest or Member. Only Global Administrators can invite users as members. Defaults to Guest.
	// The user type of the user being invited
	UserType *string `json:"userType,omitempty" tf:"user_type,omitempty"`
}

func (*InvitationInitParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationInitParameters.

func (*InvitationInitParameters) DeepCopyInto

func (in *InvitationInitParameters) DeepCopyInto(out *InvitationInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type InvitationList

type InvitationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Invitation `json:"items"`
}

InvitationList contains a list of Invitations

func (*InvitationList) DeepCopy

func (in *InvitationList) DeepCopy() *InvitationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationList.

func (*InvitationList) DeepCopyInto

func (in *InvitationList) DeepCopyInto(out *InvitationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*InvitationList) DeepCopyObject

func (in *InvitationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*InvitationList) GetItems

func (l *InvitationList) GetItems() []resource.Managed

GetItems of this InvitationList.

type InvitationObservation

type InvitationObservation struct {
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// A message block as documented below, which configures the message being sent to the invited user. If this block is omitted, no message will be sent.
	// Customize the message sent to the invited user
	Message *MessageObservation `json:"message,omitempty" tf:"message,omitempty"`

	// The URL the user can use to redeem their invitation.
	// The URL the user can use to redeem their invitation
	RedeemURL *string `json:"redeemUrl,omitempty" tf:"redeem_url,omitempty"`

	// The URL that the user should be redirected to once the invitation is redeemed.
	// The URL that the user should be redirected to once the invitation is redeemed
	RedirectURL *string `json:"redirectUrl,omitempty" tf:"redirect_url,omitempty"`

	// The display name of the user being invited.
	// The display name of the user being invited
	UserDisplayName *string `json:"userDisplayName,omitempty" tf:"user_display_name,omitempty"`

	// The email address of the user being invited.
	// The email address of the user being invited
	UserEmailAddress *string `json:"userEmailAddress,omitempty" tf:"user_email_address,omitempty"`

	// Object ID of the invited user.
	// Object ID of the invited user
	UserID *string `json:"userId,omitempty" tf:"user_id,omitempty"`

	// The user type of the user being invited. Must be one of Guest or Member. Only Global Administrators can invite users as members. Defaults to Guest.
	// The user type of the user being invited
	UserType *string `json:"userType,omitempty" tf:"user_type,omitempty"`
}

func (*InvitationObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationObservation.

func (*InvitationObservation) DeepCopyInto

func (in *InvitationObservation) DeepCopyInto(out *InvitationObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type InvitationParameters

type InvitationParameters struct {

	// A message block as documented below, which configures the message being sent to the invited user. If this block is omitted, no message will be sent.
	// Customize the message sent to the invited user
	// +kubebuilder:validation:Optional
	Message *MessageParameters `json:"message,omitempty" tf:"message,omitempty"`

	// The URL that the user should be redirected to once the invitation is redeemed.
	// The URL that the user should be redirected to once the invitation is redeemed
	// +kubebuilder:validation:Optional
	RedirectURL *string `json:"redirectUrl,omitempty" tf:"redirect_url,omitempty"`

	// The display name of the user being invited.
	// The display name of the user being invited
	// +kubebuilder:validation:Optional
	UserDisplayName *string `json:"userDisplayName,omitempty" tf:"user_display_name,omitempty"`

	// The email address of the user being invited.
	// The email address of the user being invited
	// +kubebuilder:validation:Optional
	UserEmailAddress *string `json:"userEmailAddress,omitempty" tf:"user_email_address,omitempty"`

	// The user type of the user being invited. Must be one of Guest or Member. Only Global Administrators can invite users as members. Defaults to Guest.
	// The user type of the user being invited
	// +kubebuilder:validation:Optional
	UserType *string `json:"userType,omitempty" tf:"user_type,omitempty"`
}

func (*InvitationParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationParameters.

func (*InvitationParameters) DeepCopyInto

func (in *InvitationParameters) DeepCopyInto(out *InvitationParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type InvitationSpec

type InvitationSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     InvitationParameters `json:"forProvider"`
	// THIS IS A BETA FIELD. It will be honored
	// unless the Management Policies feature flag is disabled.
	// InitProvider holds the same fields as ForProvider, with the exception
	// of Identifier and other resource reference fields. The fields that are
	// in InitProvider are merged into ForProvider when the resource is created.
	// The same fields are also added to the terraform ignore_changes hook, to
	// avoid updating them after creation. This is useful for fields that are
	// required on creation, but we do not desire to update them after creation,
	// for example because of an external controller is managing them, like an
	// autoscaler.
	InitProvider InvitationInitParameters `json:"initProvider,omitempty"`
}

InvitationSpec defines the desired state of Invitation

func (*InvitationSpec) DeepCopy

func (in *InvitationSpec) DeepCopy() *InvitationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationSpec.

func (*InvitationSpec) DeepCopyInto

func (in *InvitationSpec) DeepCopyInto(out *InvitationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type InvitationStatus

type InvitationStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        InvitationObservation `json:"atProvider,omitempty"`
}

InvitationStatus defines the observed state of Invitation.

func (*InvitationStatus) DeepCopy

func (in *InvitationStatus) DeepCopy() *InvitationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationStatus.

func (*InvitationStatus) DeepCopyInto

func (in *InvitationStatus) DeepCopyInto(out *InvitationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MessageInitParameters

type MessageInitParameters struct {

	// Email addresses of additional recipients the invitation message should be sent to. Only 1 additional recipient is currently supported by Azure.
	// Email addresses of additional recipients the invitation message should be sent to
	AdditionalRecipients []*string `json:"additionalRecipients,omitempty" tf:"additional_recipients,omitempty"`

	// Customized message body you want to send if you don't want to send the default message. Cannot be specified with language.
	// Customized message body you want to send if you don't want to send the default message
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// The language you want to send the default message in. The value specified must be in ISO 639 format. Defaults to en-US. Cannot be specified with body.
	// The language you want to send the default message in
	Language *string `json:"language,omitempty" tf:"language,omitempty"`
}

func (*MessageInitParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MessageInitParameters.

func (*MessageInitParameters) DeepCopyInto

func (in *MessageInitParameters) DeepCopyInto(out *MessageInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MessageObservation

type MessageObservation struct {

	// Email addresses of additional recipients the invitation message should be sent to. Only 1 additional recipient is currently supported by Azure.
	// Email addresses of additional recipients the invitation message should be sent to
	AdditionalRecipients []*string `json:"additionalRecipients,omitempty" tf:"additional_recipients,omitempty"`

	// Customized message body you want to send if you don't want to send the default message. Cannot be specified with language.
	// Customized message body you want to send if you don't want to send the default message
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// The language you want to send the default message in. The value specified must be in ISO 639 format. Defaults to en-US. Cannot be specified with body.
	// The language you want to send the default message in
	Language *string `json:"language,omitempty" tf:"language,omitempty"`
}

func (*MessageObservation) DeepCopy

func (in *MessageObservation) DeepCopy() *MessageObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MessageObservation.

func (*MessageObservation) DeepCopyInto

func (in *MessageObservation) DeepCopyInto(out *MessageObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MessageParameters

type MessageParameters struct {

	// Email addresses of additional recipients the invitation message should be sent to. Only 1 additional recipient is currently supported by Azure.
	// Email addresses of additional recipients the invitation message should be sent to
	// +kubebuilder:validation:Optional
	AdditionalRecipients []*string `json:"additionalRecipients,omitempty" tf:"additional_recipients,omitempty"`

	// Customized message body you want to send if you don't want to send the default message. Cannot be specified with language.
	// Customized message body you want to send if you don't want to send the default message
	// +kubebuilder:validation:Optional
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// The language you want to send the default message in. The value specified must be in ISO 639 format. Defaults to en-US. Cannot be specified with body.
	// The language you want to send the default message in
	// +kubebuilder:validation:Optional
	Language *string `json:"language,omitempty" tf:"language,omitempty"`
}

func (*MessageParameters) DeepCopy

func (in *MessageParameters) DeepCopy() *MessageParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MessageParameters.

func (*MessageParameters) DeepCopyInto

func (in *MessageParameters) DeepCopyInto(out *MessageParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL