hcireports

README

github.com/hashicorp/go-azure-sdk/resource-manager/automanage/2022-05-04/hcireports Documentation

The hcireports SDK allows for interaction with the Azure Resource Manager Service automanage (API Version 2022-05-04).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/automanage/2022-05-04/hcireports"

Client Initialization

client := hcireports.NewHCIReportsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: HCIReportsClient.Get

ctx := context.TODO()
id := hcireports.NewReportID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "configurationProfileAssignmentValue", "reportValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: HCIReportsClient.ListByConfigurationProfileAssignments

ctx := context.TODO()
id := hcireports.NewConfigurationProfileAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "configurationProfileAssignmentValue")

read, err := client.ListByConfigurationProfileAssignments(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func ValidateConfigurationProfileAssignmentID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateReportID(input interface{}, key string) (warnings []string, errors []error)
• type AssignmentReportProperties
• type ConfigurationProfileAssignmentId
  • func NewConfigurationProfileAssignmentID(subscriptionId string, resourceGroupName string, clusterName string, ...) ConfigurationProfileAssignmentId
  • func ParseConfigurationProfileAssignmentID(input string) (*ConfigurationProfileAssignmentId, error)
  • func ParseConfigurationProfileAssignmentIDInsensitively(input string) (*ConfigurationProfileAssignmentId, error)
  • func (id ConfigurationProfileAssignmentId) ID() string
  • func (id ConfigurationProfileAssignmentId) Segments() []resourceids.Segment
  • func (id ConfigurationProfileAssignmentId) String() string
• type ErrorAdditionalInfo
• type ErrorDetail
• type GetOperationResponse
• type HCIReportsClient
  • func NewHCIReportsClientWithBaseURI(sdkApi sdkEnv.Api) (*HCIReportsClient, error)
  • func (c HCIReportsClient) Get(ctx context.Context, id ReportId) (result GetOperationResponse, err error)
  • func (c HCIReportsClient) ListByConfigurationProfileAssignments(ctx context.Context, id ConfigurationProfileAssignmentId) (result ListByConfigurationProfileAssignmentsOperationResponse, err error)
• type ListByConfigurationProfileAssignmentsOperationResponse
• type Report
• type ReportId
  • func NewReportID(subscriptionId string, resourceGroupName string, clusterName string, ...) ReportId
  • func ParseReportID(input string) (*ReportId, error)
  • func ParseReportIDInsensitively(input string) (*ReportId, error)
  • func (id ReportId) ID() string
  • func (id ReportId) Segments() []resourceids.Segment
  • func (id ReportId) String() string
• type ReportList
• type ReportResource

Functions

func ValidateConfigurationProfileAssignmentID

func ValidateConfigurationProfileAssignmentID(input interface{}, key string) (warnings []string, errors []error)

ValidateConfigurationProfileAssignmentID checks that 'input' can be parsed as a Configuration Profile Assignment ID

func ValidateReportID

func ValidateReportID(input interface{}, key string) (warnings []string, errors []error)

ValidateReportID checks that 'input' can be parsed as a Report ID

Types

type AssignmentReportProperties

type AssignmentReportProperties struct {
	ConfigurationProfile *string           `json:"configurationProfile,omitempty"`
	Duration             *string           `json:"duration,omitempty"`
	EndTime              *string           `json:"endTime,omitempty"`
	Error                *ErrorDetail      `json:"error,omitempty"`
	LastModifiedTime     *string           `json:"lastModifiedTime,omitempty"`
	ReportFormatVersion  *string           `json:"reportFormatVersion,omitempty"`
	Resources            *[]ReportResource `json:"resources,omitempty"`
	StartTime            *string           `json:"startTime,omitempty"`
	Status               *string           `json:"status,omitempty"`
	Type                 *string           `json:"type,omitempty"`
}

type ConfigurationProfileAssignmentId

type ConfigurationProfileAssignmentId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	ClusterName                        string
	ConfigurationProfileAssignmentName string
}

ConfigurationProfileAssignmentId is a struct representing the Resource ID for a Configuration Profile Assignment

func NewConfigurationProfileAssignmentID

func NewConfigurationProfileAssignmentID(subscriptionId string, resourceGroupName string, clusterName string, configurationProfileAssignmentName string) ConfigurationProfileAssignmentId

NewConfigurationProfileAssignmentID returns a new ConfigurationProfileAssignmentId struct

func ParseConfigurationProfileAssignmentID

func ParseConfigurationProfileAssignmentID(input string) (*ConfigurationProfileAssignmentId, error)

ParseConfigurationProfileAssignmentID parses 'input' into a ConfigurationProfileAssignmentId

func ParseConfigurationProfileAssignmentIDInsensitively

func ParseConfigurationProfileAssignmentIDInsensitively(input string) (*ConfigurationProfileAssignmentId, error)

ParseConfigurationProfileAssignmentIDInsensitively parses 'input' case-insensitively into a ConfigurationProfileAssignmentId note: this method should only be used for API response data and not user input

func (ConfigurationProfileAssignmentId) ID

func (id ConfigurationProfileAssignmentId) ID() string

ID returns the formatted Configuration Profile Assignment ID

func (ConfigurationProfileAssignmentId) Segments

func (id ConfigurationProfileAssignmentId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Configuration Profile Assignment ID

func (ConfigurationProfileAssignmentId) String

func (id ConfigurationProfileAssignmentId) String() string

String returns a human-readable description of this Configuration Profile Assignment ID

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDetail

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Report
}

type HCIReportsClient

type HCIReportsClient struct {
	Client *resourcemanager.Client
}

func NewHCIReportsClientWithBaseURI

func NewHCIReportsClientWithBaseURI(sdkApi sdkEnv.Api) (*HCIReportsClient, error)

func (HCIReportsClient) Get

func (c HCIReportsClient) Get(ctx context.Context, id ReportId) (result GetOperationResponse, err error)

Get ...

func (HCIReportsClient) ListByConfigurationProfileAssignments

func (c HCIReportsClient) ListByConfigurationProfileAssignments(ctx context.Context, id ConfigurationProfileAssignmentId) (result ListByConfigurationProfileAssignmentsOperationResponse, err error)

ListByConfigurationProfileAssignments ...

type ListByConfigurationProfileAssignmentsOperationResponse

type ListByConfigurationProfileAssignmentsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReportList
}

type Report

type Report struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *AssignmentReportProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type ReportId

type ReportId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	ClusterName                        string
	ConfigurationProfileAssignmentName string
	ReportName                         string
}

ReportId is a struct representing the Resource ID for a Report

func NewReportID

func NewReportID(subscriptionId string, resourceGroupName string, clusterName string, configurationProfileAssignmentName string, reportName string) ReportId

NewReportID returns a new ReportId struct

func ParseReportID

func ParseReportID(input string) (*ReportId, error)

ParseReportID parses 'input' into a ReportId

func ParseReportIDInsensitively

func ParseReportIDInsensitively(input string) (*ReportId, error)

ParseReportIDInsensitively parses 'input' case-insensitively into a ReportId note: this method should only be used for API response data and not user input

func (ReportId) ID

func (id ReportId) ID() string

ID returns the formatted Report ID

func (ReportId) Segments

func (id ReportId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Report ID

func (ReportId) String

func (id ReportId) String() string

String returns a human-readable description of this Report ID

type ReportList

type ReportList struct {
	Value *[]Report `json:"value,omitempty"`
}

type ReportResource

type ReportResource struct {
	Error  *ErrorDetail `json:"error,omitempty"`
	Id     *string      `json:"id,omitempty"`
	Name   *string      `json:"name,omitempty"`
	Status *string      `json:"status,omitempty"`
	Type   *string      `json:"type,omitempty"`
}