nodereports

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2019-06-01/nodereports Documentation

The nodereports SDK allows for interaction with Azure Resource Manager automation (API Version 2019-06-01).

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/automation/2019-06-01/nodereports"

Client Initialization

client := nodereports.NewNodeReportsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NodeReportsClient.Get

ctx := context.TODO()
id := nodereports.NewReportID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "nodeId", "reportId")

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: NodeReportsClient.GetContent

ctx := context.TODO()
id := nodereports.NewReportID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "nodeId", "reportId")

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

Example Usage: NodeReportsClient.ListByNode

ctx := context.TODO()
id := nodereports.NewNodeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "nodeId")

// alternatively `client.ListByNode(ctx, id, nodereports.DefaultListByNodeOperationOptions())` can be used to do batched pagination
items, err := client.ListByNodeComplete(ctx, id, nodereports.DefaultListByNodeOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateNodeID 

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

ValidateNodeID checks that 'input' can be parsed as a Node 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 DscMetaConfiguration 

type DscMetaConfiguration struct {
	ActionAfterReboot              *string `json:"actionAfterReboot,omitempty"`
	AllowModuleOverwrite           *bool   `json:"allowModuleOverwrite,omitempty"`
	CertificateId                  *string `json:"certificateId,omitempty"`
	ConfigurationMode              *string `json:"configurationMode,omitempty"`
	ConfigurationModeFrequencyMins *int64  `json:"configurationModeFrequencyMins,omitempty"`
	RebootNodeIfNeeded             *bool   `json:"rebootNodeIfNeeded,omitempty"`
	RefreshFrequencyMins           *int64  `json:"refreshFrequencyMins,omitempty"`
}

type DscNodeReport 

type DscNodeReport struct {
	ConfigurationVersion *string               `json:"configurationVersion,omitempty"`
	EndTime              *string               `json:"endTime,omitempty"`
	Errors               *[]DscReportError     `json:"errors,omitempty"`
	HostName             *string               `json:"hostName,omitempty"`
	IPV4Addresses        *[]string             `json:"iPV4Addresses,omitempty"`
	IPV6Addresses        *[]string             `json:"iPV6Addresses,omitempty"`
	Id                   *string               `json:"id,omitempty"`
	LastModifiedTime     *string               `json:"lastModifiedTime,omitempty"`
	MetaConfiguration    *DscMetaConfiguration `json:"metaConfiguration,omitempty"`
	NumberOfResources    *int64                `json:"numberOfResources,omitempty"`
	RawErrors            *string               `json:"rawErrors,omitempty"`
	RebootRequested      *string               `json:"rebootRequested,omitempty"`
	RefreshMode          *string               `json:"refreshMode,omitempty"`
	ReportFormatVersion  *string               `json:"reportFormatVersion,omitempty"`
	ReportId             *string               `json:"reportId,omitempty"`
	Resources            *[]DscReportResource  `json:"resources,omitempty"`
	StartTime            *string               `json:"startTime,omitempty"`
	Status               *string               `json:"status,omitempty"`
	Type                 *string               `json:"type,omitempty"`
}

func (*DscNodeReport) GetEndTimeAsTime 

func (o *DscNodeReport) GetEndTimeAsTime() (*time.Time, error)

func (*DscNodeReport) GetLastModifiedTimeAsTime 

func (o *DscNodeReport) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*DscNodeReport) GetStartTimeAsTime 

func (o *DscNodeReport) GetStartTimeAsTime() (*time.Time, error)

func (*DscNodeReport) SetEndTimeAsTime 

func (o *DscNodeReport) SetEndTimeAsTime(input time.Time)

func (*DscNodeReport) SetLastModifiedTimeAsTime 

func (o *DscNodeReport) SetLastModifiedTimeAsTime(input time.Time)

func (*DscNodeReport) SetStartTimeAsTime 

func (o *DscNodeReport) SetStartTimeAsTime(input time.Time)

type DscNodeReportOperationPredicate 

type DscNodeReportOperationPredicate struct {
	ConfigurationVersion *string
	EndTime              *string
	HostName             *string
	Id                   *string
	LastModifiedTime     *string
	NumberOfResources    *int64
	RawErrors            *string
	RebootRequested      *string
	RefreshMode          *string
	ReportFormatVersion  *string
	ReportId             *string
	StartTime            *string
	Status               *string
	Type                 *string
}

func (DscNodeReportOperationPredicate) Matches 

func (p DscNodeReportOperationPredicate) Matches(input DscNodeReport) bool

type DscReportError 

type DscReportError struct {
	ErrorCode    *string `json:"errorCode,omitempty"`
	ErrorDetails *string `json:"errorDetails,omitempty"`
	ErrorMessage *string `json:"errorMessage,omitempty"`
	ErrorSource  *string `json:"errorSource,omitempty"`
	Locale       *string `json:"locale,omitempty"`
	ResourceId   *string `json:"resourceId,omitempty"`
}

type DscReportResource 

type DscReportResource struct {
	DependsOn         *[]DscReportResourceNavigation `json:"dependsOn,omitempty"`
	DurationInSeconds *float64                       `json:"durationInSeconds,omitempty"`
	Error             *string                        `json:"error,omitempty"`
	ModuleName        *string                        `json:"moduleName,omitempty"`
	ModuleVersion     *string                        `json:"moduleVersion,omitempty"`
	ResourceId        *string                        `json:"resourceId,omitempty"`
	ResourceName      *string                        `json:"resourceName,omitempty"`
	SourceInfo        *string                        `json:"sourceInfo,omitempty"`
	StartDate         *string                        `json:"startDate,omitempty"`
	Status            *string                        `json:"status,omitempty"`
}

func (*DscReportResource) GetStartDateAsTime 

func (o *DscReportResource) GetStartDateAsTime() (*time.Time, error)

func (*DscReportResource) SetStartDateAsTime 

func (o *DscReportResource) SetStartDateAsTime(input time.Time)

type DscReportResourceNavigation 

type DscReportResourceNavigation struct {
	ResourceId *string `json:"resourceId,omitempty"`
}

type GetContentOperationResponse 

type GetContentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *interface{}
}

type GetOperationResponse 

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

type ListByNodeCompleteResult 

type ListByNodeCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DscNodeReport
}

type ListByNodeCustomPager added in v0.20240628.1153531 

type ListByNodeCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByNodeCustomPager) NextPageLink() *odata.Link

type ListByNodeOperationOptions 

type ListByNodeOperationOptions struct {
	Filter *string
}

func DefaultListByNodeOperationOptions 

func DefaultListByNodeOperationOptions() ListByNodeOperationOptions

func (ListByNodeOperationOptions) ToHeaders added in v0.20240209.1164150 

func (o ListByNodeOperationOptions) ToHeaders() *client.Headers

func (ListByNodeOperationOptions) ToOData added in v0.20240209.1164150 

func (o ListByNodeOperationOptions) ToOData() *odata.Query

func (ListByNodeOperationOptions) ToQuery added in v0.20240209.1164150 

func (o ListByNodeOperationOptions) ToQuery() *client.QueryParams

type ListByNodeOperationResponse 

type ListByNodeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DscNodeReport
}

type NodeId 

type NodeId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	NodeId                string
}

NodeId is a struct representing the Resource ID for a Node

func NewNodeID 

func NewNodeID(subscriptionId string, resourceGroupName string, automationAccountName string, nodeId string) NodeId

NewNodeID returns a new NodeId struct

func ParseNodeID 

func ParseNodeID(input string) (*NodeId, error)

ParseNodeID parses 'input' into a NodeId

func ParseNodeIDInsensitively 

func ParseNodeIDInsensitively(input string) (*NodeId, error)

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

func (*NodeId) FromParseResult 

func (id *NodeId) FromParseResult(input resourceids.ParseResult) error

func (NodeId) ID 

func (id NodeId) ID() string

ID returns the formatted Node ID

func (NodeId) Segments 

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

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

func (NodeId) String 

func (id NodeId) String() string

String returns a human-readable description of this Node ID

type NodeReportsClient 

type NodeReportsClient struct {
	Client *resourcemanager.Client
}

func NewNodeReportsClientWithBaseURI 

func NewNodeReportsClientWithBaseURI(sdkApi sdkEnv.Api) (*NodeReportsClient, error)

func (NodeReportsClient) Get 

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

Get ...

func (NodeReportsClient) GetContent 

func (c NodeReportsClient) GetContent(ctx context.Context, id ReportId) (result GetContentOperationResponse, err error)

GetContent ...

func (NodeReportsClient) ListByNode 

func (c NodeReportsClient) ListByNode(ctx context.Context, id NodeId, options ListByNodeOperationOptions) (result ListByNodeOperationResponse, err error)

ListByNode ...

func (NodeReportsClient) ListByNodeComplete 

func (c NodeReportsClient) ListByNodeComplete(ctx context.Context, id NodeId, options ListByNodeOperationOptions) (ListByNodeCompleteResult, error)

ListByNodeComplete retrieves all the results into a single object

func (NodeReportsClient) ListByNodeCompleteMatchingPredicate 

func (c NodeReportsClient) ListByNodeCompleteMatchingPredicate(ctx context.Context, id NodeId, options ListByNodeOperationOptions, predicate DscNodeReportOperationPredicate) (result ListByNodeCompleteResult, err error)

ListByNodeCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ReportId 

type ReportId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	NodeId                string
	ReportId              string
}

ReportId is a struct representing the Resource ID for a Report

func NewReportID 

func NewReportID(subscriptionId string, resourceGroupName string, automationAccountName string, nodeId string, reportId 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) FromParseResult 

func (id *ReportId) FromParseResult(input resourceids.ParseResult) error

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.