internal

Documentation

Index

• func GetCachedSubscriptionNameByID(subscriptionId string) (name string, found bool)
• type DocumentationClient
  • func GetSingletonDocumentationClient() (*DocumentationClient, error)
  • func (client *DocumentationClient) CleanDocsDir()
  • func (client *DocumentationClient) GenerateMarkdown(verbose bool) error
  • func (client *DocumentationClient) GetDocsDir() string
  • func (client *DocumentationClient) GetSubscriptionById(id string) *SubscriptionWrapper
  • func (client *DocumentationClient) GetSubscriptionNameByID(subscriptionId string) (name string, found bool)
  • func (client *DocumentationClient) GetSubscriptions() []*SubscriptionWrapper
  • func (client *DocumentationClient) GetVNETs() []*VNETWrapper
  • func (client *DocumentationClient) WriteDocumentation() error
• type IPSpace
  • func NewIPSPace(vnet *VNETWrapper, addressSpace string) *IPSpace
  • func (ipSpace *IPSpace) AddSubnet(subnet *armnetwork.Subnet) bool
• type Markdown
  • func NewMarkdown() *Markdown
  • func (client *Markdown) GenerateLink(title string, link string) string
  • func (client *Markdown) GenerateList(items []any) (listText string)
  • func (client *Markdown) GenerateListItem(itemText any) string
  • func (client *Markdown) GenerateListOfStringPointers(items []*string) (listText string)
  • func (client *Markdown) GenerateTableHeader(headers ...string) string
  • func (client *Markdown) GenerateTableRow(fields ...string) string
  • func (client *Markdown) GenerateTableSeparator(columnCount int) string
  • func (client *Markdown) GenerateTitle(title string, level int) string
• type SubscriptionWrapper
  • func NewSubscriptionWrapper(sub armsubscription.Subscription) SubscriptionWrapper
  • func (sub *SubscriptionWrapper) WriteMarkdown() error
• type VNETWrapper
  • func GetWrappedVNETsInSubscriptions(subscriptions []*SubscriptionWrapper) (vnets []*VNETWrapper, err error)
  • func NewVNETWrapper(vnet *armnetwork.VirtualNetwork, subscriptionWrapper SubscriptionWrapper) VNETWrapper
  • func (vnet *VNETWrapper) MarkdownGenerate() string
  • func (vnet *VNETWrapper) WriteMarkdown() error

Functions

func GetCachedSubscriptionNameByID

func GetCachedSubscriptionNameByID(subscriptionId string) (name string, found bool)

Types

type DocumentationClient

type DocumentationClient struct {
	*Markdown
	// contains filtered or unexported fields
}

func GetSingletonDocumentationClient

func GetSingletonDocumentationClient() (*DocumentationClient, error)

func (*DocumentationClient) CleanDocsDir

func (client *DocumentationClient) CleanDocsDir()

func (*DocumentationClient) GenerateMarkdown

func (client *DocumentationClient) GenerateMarkdown(verbose bool) error

func (*DocumentationClient) GetDocsDir

func (client *DocumentationClient) GetDocsDir() string

func (*DocumentationClient) GetSubscriptionById

func (client *DocumentationClient) GetSubscriptionById(id string) *SubscriptionWrapper

func (*DocumentationClient) GetSubscriptionNameByID

func (client *DocumentationClient) GetSubscriptionNameByID(subscriptionId string) (name string, found bool)

func (*DocumentationClient) GetSubscriptions

func (client *DocumentationClient) GetSubscriptions() []*SubscriptionWrapper

func (*DocumentationClient) GetVNETs

func (client *DocumentationClient) GetVNETs() []*VNETWrapper

func (*DocumentationClient) WriteDocumentation

func (client *DocumentationClient) WriteDocumentation() error

type IPSpace

type IPSpace struct {
	// contains filtered or unexported fields
}

func NewIPSPace

func NewIPSPace(vnet *VNETWrapper, addressSpace string) *IPSpace

func (*IPSpace) AddSubnet

func (ipSpace *IPSpace) AddSubnet(subnet *armnetwork.Subnet) bool

type Markdown

type Markdown struct {
	// contains filtered or unexported fields
}

func NewMarkdown

func NewMarkdown() *Markdown

func (*Markdown) GenerateLink

func (client *Markdown) GenerateLink(title string, link string) string

func (*Markdown) GenerateList

func (client *Markdown) GenerateList(items []any) (listText string)

func (*Markdown) GenerateListItem

func (client *Markdown) GenerateListItem(itemText any) string

func (*Markdown) GenerateListOfStringPointers

func (client *Markdown) GenerateListOfStringPointers(items []*string) (listText string)

func (*Markdown) GenerateTableHeader

func (client *Markdown) GenerateTableHeader(headers ...string) string

func (*Markdown) GenerateTableRow

func (client *Markdown) GenerateTableRow(fields ...string) string

func (*Markdown) GenerateTableSeparator

func (client *Markdown) GenerateTableSeparator(columnCount int) string

func (*Markdown) GenerateTitle

func (client *Markdown) GenerateTitle(title string, level int) string

type SubscriptionWrapper

type SubscriptionWrapper struct {
	*Markdown
	*armsubscription.Subscription
	// contains filtered or unexported fields
}

func NewSubscriptionWrapper

func NewSubscriptionWrapper(sub armsubscription.Subscription) SubscriptionWrapper

func (*SubscriptionWrapper) WriteMarkdown

func (sub *SubscriptionWrapper) WriteMarkdown() error

type VNETWrapper

type VNETWrapper struct {
	*Markdown
	*armnetwork.VirtualNetwork
	ResourceGroup string
	Subscription  SubscriptionWrapper
	IPSpaces      []*IPSpace
}

func GetWrappedVNETsInSubscriptions

func GetWrappedVNETsInSubscriptions(subscriptions []*SubscriptionWrapper) (vnets []*VNETWrapper, err error)

func NewVNETWrapper

func NewVNETWrapper(vnet *armnetwork.VirtualNetwork, subscriptionWrapper SubscriptionWrapper) VNETWrapper

func (*VNETWrapper) MarkdownGenerate

func (vnet *VNETWrapper) MarkdownGenerate() string

func (*VNETWrapper) WriteMarkdown

func (vnet *VNETWrapper) WriteMarkdown() error