resourcegroup

Documentation

Overview

Package resourcegroup provides functions and data structures to interact with Azure Resource Group resources.

Index

• type AzureResourceReport
  • func EnumerateResourceGroups(ctx context.Context, cfg config.AzureConfig) (*AzureResourceReport, error)
• type AzureResources
• type Details

Types

type AzureResourceReport

type AzureResourceReport struct {
	Resources AzureResources `json:"resources" yaml:"resources"`
	Errors    []string       `json:"errors" yaml:"errors"`
}

AzureResourceReport contains the AzureResources and any non-fatal errors encountered during enumeration.

func EnumerateResourceGroups

func EnumerateResourceGroups(ctx context.Context, cfg config.AzureConfig) (*AzureResourceReport, error)

EnumerateResourceGroups enumerates all Resource Groups in the subscription, returning a report of the Resource Groups and any non-fatal errors encountered.

type AzureResources

type AzureResources struct {
	SubscriptionID string    `json:"subscription_id" yaml:"subscription_id"`
	TenantID       string    `json:"tenant_id" yaml:"tenant_id"`
	ResourceGroups []Details `json:"resource_groups" yaml:"resource_groups"`
}

AzureResources contains details about all Resource Groups in the subscription.

type Details

type Details struct {
	ResourceGroupName string                     `json:"resource_group_name" yaml:"resource_group_name"`
	Location          string                     `json:"location" yaml:"location"`
	Details           armresources.ResourceGroup `json:"details" yaml:"details"`
}

Details contains details about a single Resource Group.