infrastructureinsights

package
v24.1.0 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2019 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package infrastructureinsights implements the Azure ARM Infrastructureinsights service API version 2016-05-01.

InfrastructureInsights Admin Client

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Infrastructureinsights
	DefaultBaseURI = "https://adminmanagement.local.azurestack.external"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type Alert 

type Alert struct {
	autorest.Response `json:"-"`
	// AlertModel - Holds all information related to Alerts
	*AlertModel `json:"properties,omitempty"`
	// ID - URI of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of resource.
	Type *string `json:"type,omitempty"`
	// Location - Location where resource is location.
	Location *string `json:"location,omitempty"`
	// Tags - List of key value pairs.
	Tags map[string]*string `json:"tags"`
}

Alert this class models an alert resource.

func (Alert) MarshalJSON 

func (a Alert) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Alert.

func (*Alert) UnmarshalJSON 

func (a *Alert) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Alert struct.

type AlertList 

type AlertList struct {
	autorest.Response `json:"-"`
	// Value - Holds all alerts in this page.
	Value *[]Alert `json:"value,omitempty"`
	// NextLink - Points to the next page.
	NextLink *string `json:"nextLink,omitempty"`
}

AlertList a pageable list of Alerts

func (AlertList) IsEmpty 

func (al AlertList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AlertListIterator 

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

AlertListIterator provides access to a complete listing of Alert values.

func (*AlertListIterator) Next 

func (iter *AlertListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AlertListIterator) NotDone 

func (iter AlertListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AlertListIterator) Response 

func (iter AlertListIterator) Response() AlertList

Response returns the raw server response from the last page request.

func (AlertListIterator) Value 

func (iter AlertListIterator) Value() Alert

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AlertListPage 

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

AlertListPage contains a page of Alert values.

func (*AlertListPage) Next 

func (page *AlertListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AlertListPage) NotDone 

func (page AlertListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AlertListPage) Response 

func (page AlertListPage) Response() AlertList

Response returns the raw server response from the last page request.

func (AlertListPage) Values 

func (page AlertListPage) Values() []Alert

Values returns the slice of values for the current page or nil if there are no values.

type AlertModel 

type AlertModel struct {
	// ClosedTimestamp - Gets or sets the closed timestamp of the alert.
	ClosedTimestamp *string `json:"closedTimestamp,omitempty"`
	// CreatedTimestamp - Gets or sets the created timestamp of the alert.
	CreatedTimestamp *string `json:"createdTimestamp,omitempty"`
	// Description - Gets or sets the description of the alert.
	Description *[]map[string]*string `json:"description,omitempty"`
	// FaultID - Gets or sets the fault id of the alert.
	FaultID *string `json:"faultId,omitempty"`
	// AlertID - Gets or sets the id of the alert.
	AlertID *string `json:"alertId,omitempty"`
	// FaultTypeID - Gets or sets the fault type id of the alert.
	FaultTypeID *string `json:"faultTypeId,omitempty"`
	// LastUpdatedTimestamp - Gets or sets last updated timestamp of the alert.
	LastUpdatedTimestamp *string `json:"lastUpdatedTimestamp,omitempty"`
	// AlertProperties - Gets or sets properties of the alert.
	AlertProperties map[string]*string `json:"alertProperties"`
	// Remediation - Gets or sets the admin friendly remediation instructions for the alert.
	Remediation *[]map[string]*string `json:"remediation,omitempty"`
	// ResourceRegistrationID - Gets or sets the registration id of the atomic component the alert belongs to.  This is null if not associated with a resource.
	ResourceRegistrationID *string `json:"resourceRegistrationId,omitempty"`
	// ResourceProviderRegistrationID - Gets or sets the registration id of the service the alert belongs to.
	ResourceProviderRegistrationID *string `json:"resourceProviderRegistrationId,omitempty"`
	// Severity - Gets or sets the severity of the alert.
	Severity *string `json:"severity,omitempty"`
	// State - Gets or sets the state of the alert.
	State *string `json:"state,omitempty"`
	// Title - Gets or sets the ResourceId for the impacted item.
	Title *string `json:"title,omitempty"`
	// ImpactedResourceID - Gets or sets the ResourceId for the impacted item.
	ImpactedResourceID *string `json:"impactedResourceId,omitempty"`
	// ImpactedResourceDisplayName - Gets or sets the display name for the impacted item.
	ImpactedResourceDisplayName *string `json:"impactedResourceDisplayName,omitempty"`
	// ClosedByUserAlias - Gets or sets the user alias who closed the alert.
	ClosedByUserAlias *string `json:"closedByUserAlias,omitempty"`
}

AlertModel holds Alert data

func (AlertModel) MarshalJSON 

func (am AlertModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AlertModel.

type AlertSummary 

type AlertSummary struct {
	// CriticalAlertCount - How many critical alerts this service has.
	CriticalAlertCount *int32 `json:"criticalAlertCount,omitempty"`
	// WarningAlertCount - How many warning alerts this service has.
	WarningAlertCount *int32 `json:"warningAlertCount,omitempty"`
}

AlertSummary summary of the alerts.

type AlertsClient 

type AlertsClient struct {
	BaseClient
}

AlertsClient is the infrastructureInsights Admin Client

func NewAlertsClient 

func NewAlertsClient(subscriptionID string) AlertsClient

NewAlertsClient creates an instance of the AlertsClient client.

func NewAlertsClientWithBaseURI 

func NewAlertsClientWithBaseURI(baseURI string, subscriptionID string) AlertsClient

NewAlertsClientWithBaseURI creates an instance of the AlertsClient client.

func (AlertsClient) Close 

func (client AlertsClient) Close(ctx context.Context, location string, alertName string, userParameter string, alert Alert) (result Alert, err error)

Close close an alert.

location is location name. alertName is name of the alert. userParameter is the username used to perform the operation. alert is updated Alert Parameter.

func (AlertsClient) ClosePreparer 

func (client AlertsClient) ClosePreparer(ctx context.Context, location string, alertName string, userParameter string, alert Alert) (*http.Request, error)

ClosePreparer prepares the Close request.

func (AlertsClient) CloseResponder 

func (client AlertsClient) CloseResponder(resp *http.Response) (result Alert, err error)

CloseResponder handles the response to the Close request. The method always closes the http.Response Body.

func (AlertsClient) CloseSender 

func (client AlertsClient) CloseSender(req *http.Request) (*http.Response, error)

CloseSender sends the Close request. The method will close the http.Response Body if it receives an error.

func (AlertsClient) Get 

func (client AlertsClient) Get(ctx context.Context, location string, alertName string) (result Alert, err error)

Get get an alert.

location is location name. alertName is name of the alert.

func (AlertsClient) GetPreparer 

func (client AlertsClient) GetPreparer(ctx context.Context, location string, alertName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AlertsClient) GetResponder 

func (client AlertsClient) GetResponder(resp *http.Response) (result Alert, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AlertsClient) GetSender 

func (client AlertsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (AlertsClient) List 

func (client AlertsClient) List(ctx context.Context, location string, filter string) (result AlertListPage, err error)

List returns the list of all alerts in a given location.

location is location name. filter is oData filter parameter.

func (AlertsClient) ListComplete 

func (client AlertsClient) ListComplete(ctx context.Context, location string, filter string) (result AlertListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (AlertsClient) ListPreparer 

func (client AlertsClient) ListPreparer(ctx context.Context, location string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (AlertsClient) ListResponder 

func (client AlertsClient) ListResponder(resp *http.Response) (result AlertList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AlertsClient) ListSender 

func (client AlertsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Infrastructureinsights.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BaseHealth 

type BaseHealth struct {
	// AlertSummary - Gets or sets the alert summary.
	AlertSummary *AlertSummary `json:"alertSummary,omitempty"`
	// HealthState - Gets or sets the health status.
	HealthState *string `json:"healthState,omitempty"`
	// Namespace - Gets or sets the name space.
	Namespace *string `json:"namespace,omitempty"`
	// RegistrationID - Gets or sets the registration id.
	RegistrationID *string `json:"registrationId,omitempty"`
	// RoutePrefix - Gets or sets the route prefix.
	RoutePrefix *string `json:"routePrefix,omitempty"`
}

BaseHealth models the base properties for health resource.

type Metrics 

type Metrics struct {
	// Name - Name of the usage metric.
	Name *string `json:"name,omitempty"`
	// MaCounterName - Name of the usage metric.
	MaCounterName *string `json:"maCounterName,omitempty"`
	// ObservedTimestamp - Name of the usage metric.
	ObservedTimestamp *date.Time `json:"observedTimestamp,omitempty"`
	// SourceType - Name of the usage metric.
	SourceType *string `json:"sourceType,omitempty"`
	// SourceName - Source of the metric. Possible values include: 'PhysicalNode', 'VirtualMachine', 'ResourceProvider'
	SourceName MetricsSourceType `json:"sourceName,omitempty"`
	// Unit - Unit for the metric. Possible values include: 'One', 'Percentage', 'B', 'KB', 'MB', 'GB', 'TB'
	Unit MetricsUnit `json:"unit,omitempty"`
	// Value - Name of the usage metric.
	Value *float64 `json:"value,omitempty"`
}

Metrics metrics for a source.

type MetricsSourceType 

type MetricsSourceType string

MetricsSourceType enumerates the values for metrics source type. 

const (
	// PhysicalNode ...
	PhysicalNode MetricsSourceType = "PhysicalNode"
	// ResourceProvider ...
	ResourceProvider MetricsSourceType = "ResourceProvider"
	// VirtualMachine ...
	VirtualMachine MetricsSourceType = "VirtualMachine"
)

func PossibleMetricsSourceTypeValues 

func PossibleMetricsSourceTypeValues() []MetricsSourceType

PossibleMetricsSourceTypeValues returns an array of possible values for the MetricsSourceType const type.

type MetricsUnit 

type MetricsUnit string

MetricsUnit enumerates the values for metrics unit. 

const (
	// B ...
	B MetricsUnit = "B"
	// GB ...
	GB MetricsUnit = "GB"
	// KB ...
	KB MetricsUnit = "KB"
	// MB ...
	MB MetricsUnit = "MB"
	// One ...
	One MetricsUnit = "One"
	// Percentage ...
	Percentage MetricsUnit = "Percentage"
	// TB ...
	TB MetricsUnit = "TB"
)

func PossibleMetricsUnitValues 

func PossibleMetricsUnitValues() []MetricsUnit

PossibleMetricsUnitValues returns an array of possible values for the MetricsUnit const type.

type RegionHealth 

type RegionHealth struct {
	autorest.Response `json:"-"`
	// RegionHealthModel - Contains information related to a regions health.
	*RegionHealthModel `json:"properties,omitempty"`
	// ID - URI of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of resource.
	Type *string `json:"type,omitempty"`
	// Location - Location where resource is location.
	Location *string `json:"location,omitempty"`
	// Tags - List of key value pairs.
	Tags map[string]*string `json:"tags"`
}

RegionHealth contains information related to a regions health.

func (RegionHealth) MarshalJSON 

func (rh RegionHealth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RegionHealth.

func (*RegionHealth) UnmarshalJSON 

func (rh *RegionHealth) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RegionHealth struct.

type RegionHealthList 

type RegionHealthList struct {
	autorest.Response `json:"-"`
	// Value - Array of region health items
	Value *[]RegionHealth `json:"value,omitempty"`
	// NextLink - URI to next page.
	NextLink *string `json:"nextLink,omitempty"`
}

RegionHealthList pageable list of region health items.

func (RegionHealthList) IsEmpty 

func (rhl RegionHealthList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RegionHealthListIterator 

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

RegionHealthListIterator provides access to a complete listing of RegionHealth values.

func (*RegionHealthListIterator) Next 

func (iter *RegionHealthListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (RegionHealthListIterator) NotDone 

func (iter RegionHealthListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (RegionHealthListIterator) Response 

func (iter RegionHealthListIterator) Response() RegionHealthList

Response returns the raw server response from the last page request.

func (RegionHealthListIterator) Value 

func (iter RegionHealthListIterator) Value() RegionHealth

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type RegionHealthListPage 

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

RegionHealthListPage contains a page of RegionHealth values.

func (*RegionHealthListPage) Next 

func (page *RegionHealthListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (RegionHealthListPage) NotDone 

func (page RegionHealthListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (RegionHealthListPage) Response 

func (page RegionHealthListPage) Response() RegionHealthList

Response returns the raw server response from the last page request.

func (RegionHealthListPage) Values 

func (page RegionHealthListPage) Values() []RegionHealth

Values returns the slice of values for the current page or nil if there are no values.

type RegionHealthModel 

type RegionHealthModel struct {
	// AlertSummary - Summary of alerts.
	AlertSummary *AlertSummary `json:"alertSummary,omitempty"`
	// UsageMetrics - List of usage metrics for this region.
	UsageMetrics *[]UsageMetrics `json:"usageMetrics,omitempty"`
}

RegionHealthModel contains information related to a regions health.

type RegionHealthsClient 

type RegionHealthsClient struct {
	BaseClient
}

RegionHealthsClient is the infrastructureInsights Admin Client

func NewRegionHealthsClient 

func NewRegionHealthsClient(subscriptionID string) RegionHealthsClient

NewRegionHealthsClient creates an instance of the RegionHealthsClient client.

func NewRegionHealthsClientWithBaseURI 

func NewRegionHealthsClientWithBaseURI(baseURI string, subscriptionID string) RegionHealthsClient

NewRegionHealthsClientWithBaseURI creates an instance of the RegionHealthsClient client.

func (RegionHealthsClient) Get 

func (client RegionHealthsClient) Get(ctx context.Context, location string, region string) (result RegionHealth, err error)

Get get health status of a region.

location is location name. region is name of the region

func (RegionHealthsClient) GetPreparer 

func (client RegionHealthsClient) GetPreparer(ctx context.Context, location string, region string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RegionHealthsClient) GetResponder 

func (client RegionHealthsClient) GetResponder(resp *http.Response) (result RegionHealth, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (RegionHealthsClient) GetSender 

func (client RegionHealthsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (RegionHealthsClient) List 

func (client RegionHealthsClient) List(ctx context.Context, location string, filter string) (result RegionHealthListPage, err error)

List get the list of all regions health status.

location is location name. filter is oData filter parameter.

func (RegionHealthsClient) ListComplete 

func (client RegionHealthsClient) ListComplete(ctx context.Context, location string, filter string) (result RegionHealthListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (RegionHealthsClient) ListPreparer 

func (client RegionHealthsClient) ListPreparer(ctx context.Context, location string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (RegionHealthsClient) ListResponder 

func (client RegionHealthsClient) ListResponder(resp *http.Response) (result RegionHealthList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (RegionHealthsClient) ListSender 

func (client RegionHealthsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Resource 

type Resource struct {
	// ID - URI of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of resource.
	Type *string `json:"type,omitempty"`
	// Location - Location where resource is location.
	Location *string `json:"location,omitempty"`
	// Tags - List of key value pairs.
	Tags map[string]*string `json:"tags"`
}

Resource base Resource Object

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceHealth 

type ResourceHealth struct {
	autorest.Response `json:"-"`
	// ResourceHealthModel - Health information related to a resource.
	*ResourceHealthModel `json:"properties,omitempty"`
	// ID - URI of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of resource.
	Type *string `json:"type,omitempty"`
	// Location - Location where resource is location.
	Location *string `json:"location,omitempty"`
	// Tags - List of key value pairs.
	Tags map[string]*string `json:"tags"`
}

ResourceHealth health information related to a resource.

func (ResourceHealth) MarshalJSON 

func (rh ResourceHealth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceHealth.

func (*ResourceHealth) UnmarshalJSON 

func (rh *ResourceHealth) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceHealth struct.

type ResourceHealthList 

type ResourceHealthList struct {
	autorest.Response `json:"-"`
	// Value - Array of of resource healths
	Value *[]ResourceHealth `json:"value,omitempty"`
	// NextLink - URI to next page.
	NextLink *string `json:"nextLink,omitempty"`
}

ResourceHealthList pageable list of resource healths.

func (ResourceHealthList) IsEmpty 

func (rhl ResourceHealthList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceHealthListIterator 

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

ResourceHealthListIterator provides access to a complete listing of ResourceHealth values.

func (*ResourceHealthListIterator) Next 

func (iter *ResourceHealthListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ResourceHealthListIterator) NotDone 

func (iter ResourceHealthListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ResourceHealthListIterator) Response 

func (iter ResourceHealthListIterator) Response() ResourceHealthList

Response returns the raw server response from the last page request.

func (ResourceHealthListIterator) Value 

func (iter ResourceHealthListIterator) Value() ResourceHealth

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ResourceHealthListPage 

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

ResourceHealthListPage contains a page of ResourceHealth values.

func (*ResourceHealthListPage) Next 

func (page *ResourceHealthListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ResourceHealthListPage) NotDone 

func (page ResourceHealthListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ResourceHealthListPage) Response 

func (page ResourceHealthListPage) Response() ResourceHealthList

Response returns the raw server response from the last page request.

func (ResourceHealthListPage) Values 

func (page ResourceHealthListPage) Values() []ResourceHealth

Values returns the slice of values for the current page or nil if there are no values.

type ResourceHealthModel 

type ResourceHealthModel struct {
	// ResourceLocation - Gets or sets the resource location.
	ResourceLocation *string `json:"resourceLocation,omitempty"`
	// ResourceName - Gets or sets the resource name.
	ResourceName *string `json:"resourceName,omitempty"`
	// ResourceDisplayName - Gets or sets the resource display name.
	ResourceDisplayName *string `json:"resourceDisplayName,omitempty"`
	// ResourceType - Gets or sets the resource type.
	ResourceType *string `json:"resourceType,omitempty"`
	// ResourceURI - Gets or sets the resource uri.
	ResourceURI *string `json:"resourceURI,omitempty"`
	// RpRegistrationID - Gets or sets the resource provider registration id.
	RpRegistrationID *string `json:"rpRegistrationId,omitempty"`
	// UsageMetrics - Gets or sets the usage metrics.
	UsageMetrics *[]UsageMetrics `json:"usageMetrics,omitempty"`
	// AlertSummary - Gets or sets the alert summary.
	AlertSummary *AlertSummary `json:"alertSummary,omitempty"`
	// HealthState - Gets or sets the health status.
	HealthState *string `json:"healthState,omitempty"`
	// Namespace - Gets or sets the name space.
	Namespace *string `json:"namespace,omitempty"`
	// RegistrationID - Gets or sets the registration id.
	RegistrationID *string `json:"registrationId,omitempty"`
	// RoutePrefix - Gets or sets the route prefix.
	RoutePrefix *string `json:"routePrefix,omitempty"`
}

ResourceHealthModel health information related to a resource.

type ResourceHealthsClient 

type ResourceHealthsClient struct {
	BaseClient
}

ResourceHealthsClient is the infrastructureInsights Admin Client

func NewResourceHealthsClient 

func NewResourceHealthsClient(subscriptionID string) ResourceHealthsClient

NewResourceHealthsClient creates an instance of the ResourceHealthsClient client.

func NewResourceHealthsClientWithBaseURI 

func NewResourceHealthsClientWithBaseURI(baseURI string, subscriptionID string) ResourceHealthsClient

NewResourceHealthsClientWithBaseURI creates an instance of the ResourceHealthsClient client.

func (ResourceHealthsClient) Get 

func (client ResourceHealthsClient) Get(ctx context.Context, location string, serviceRegistrationID string, resourceRegistrationID string, filter string) (result ResourceHealth, err error)

Get get health information about a resources.

location is location name. serviceRegistrationID is service registration id. resourceRegistrationID is resource registration id. filter is oData filter parameter.

func (ResourceHealthsClient) GetPreparer 

func (client ResourceHealthsClient) GetPreparer(ctx context.Context, location string, serviceRegistrationID string, resourceRegistrationID string, filter string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ResourceHealthsClient) GetResponder 

func (client ResourceHealthsClient) GetResponder(resp *http.Response) (result ResourceHealth, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ResourceHealthsClient) GetSender 

func (client ResourceHealthsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ResourceHealthsClient) List 

func (client ResourceHealthsClient) List(ctx context.Context, location string, serviceRegistrationID string, filter string) (result ResourceHealthListPage, err error)

List get a list of resources?.

location is location name. serviceRegistrationID is service registration id. filter is oData filter parameter.

func (ResourceHealthsClient) ListComplete 

func (client ResourceHealthsClient) ListComplete(ctx context.Context, location string, serviceRegistrationID string, filter string) (result ResourceHealthListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ResourceHealthsClient) ListPreparer 

func (client ResourceHealthsClient) ListPreparer(ctx context.Context, location string, serviceRegistrationID string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (ResourceHealthsClient) ListResponder 

func (client ResourceHealthsClient) ListResponder(resp *http.Response) (result ResourceHealthList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ResourceHealthsClient) ListSender 

func (client ResourceHealthsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ServiceHealth 

type ServiceHealth struct {
	autorest.Response `json:"-"`
	// ServiceHealthModel - Holds information about a services health.
	*ServiceHealthModel `json:"properties,omitempty"`
	// ID - URI of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of resource.
	Type *string `json:"type,omitempty"`
	// Location - Location where resource is location.
	Location *string `json:"location,omitempty"`
	// Tags - List of key value pairs.
	Tags map[string]*string `json:"tags"`
}

ServiceHealth holds information about a services health.

func (ServiceHealth) MarshalJSON 

func (sh ServiceHealth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceHealth.

func (*ServiceHealth) UnmarshalJSON 

func (sh *ServiceHealth) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceHealth struct.

type ServiceHealthList 

type ServiceHealthList struct {
	autorest.Response `json:"-"`
	// Value - Array of service health instances.
	Value *[]ServiceHealth `json:"value,omitempty"`
	// NextLink - URI of the next page.
	NextLink *string `json:"nextLink,omitempty"`
}

ServiceHealthList pageable list of service health instances.

func (ServiceHealthList) IsEmpty 

func (shl ServiceHealthList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ServiceHealthListIterator 

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

ServiceHealthListIterator provides access to a complete listing of ServiceHealth values.

func (*ServiceHealthListIterator) Next 

func (iter *ServiceHealthListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ServiceHealthListIterator) NotDone 

func (iter ServiceHealthListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ServiceHealthListIterator) Response 

func (iter ServiceHealthListIterator) Response() ServiceHealthList

Response returns the raw server response from the last page request.

func (ServiceHealthListIterator) Value 

func (iter ServiceHealthListIterator) Value() ServiceHealth

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ServiceHealthListPage 

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

ServiceHealthListPage contains a page of ServiceHealth values.

func (*ServiceHealthListPage) Next 

func (page *ServiceHealthListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ServiceHealthListPage) NotDone 

func (page ServiceHealthListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ServiceHealthListPage) Response 

func (page ServiceHealthListPage) Response() ServiceHealthList

Response returns the raw server response from the last page request.

func (ServiceHealthListPage) Values 

func (page ServiceHealthListPage) Values() []ServiceHealth

Values returns the slice of values for the current page or nil if there are no values.

type ServiceHealthModel 

type ServiceHealthModel struct {
	// DisplayName - Name of the alert.
	DisplayName *string `json:"displayName,omitempty"`
	// ServiceLocation - Location of the service.
	ServiceLocation *string `json:"serviceLocation,omitempty"`
	// InfraURI - The route prefix to the alert.
	InfraURI *string `json:"infraURI,omitempty"`
	// AlertSummary - Gets or sets the alert summary.
	AlertSummary *AlertSummary `json:"alertSummary,omitempty"`
	// HealthState - Gets or sets the health status.
	HealthState *string `json:"healthState,omitempty"`
	// Namespace - Gets or sets the name space.
	Namespace *string `json:"namespace,omitempty"`
	// RegistrationID - Gets or sets the registration id.
	RegistrationID *string `json:"registrationId,omitempty"`
	// RoutePrefix - Gets or sets the route prefix.
	RoutePrefix *string `json:"routePrefix,omitempty"`
}

ServiceHealthModel holds information about a services health.

type ServiceHealthsClient 

type ServiceHealthsClient struct {
	BaseClient
}

ServiceHealthsClient is the infrastructureInsights Admin Client

func NewServiceHealthsClient 

func NewServiceHealthsClient(subscriptionID string) ServiceHealthsClient

NewServiceHealthsClient creates an instance of the ServiceHealthsClient client.

func NewServiceHealthsClientWithBaseURI 

func NewServiceHealthsClientWithBaseURI(baseURI string, subscriptionID string) ServiceHealthsClient

NewServiceHealthsClientWithBaseURI creates an instance of the ServiceHealthsClient client.

func (ServiceHealthsClient) Get 

func (client ServiceHealthsClient) Get(ctx context.Context, location string, serviceHealth string) (result ServiceHealth, err error)

Get get a services health

location is location name. serviceHealth is service Health name.

func (ServiceHealthsClient) GetPreparer 

func (client ServiceHealthsClient) GetPreparer(ctx context.Context, location string, serviceHealth string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ServiceHealthsClient) GetResponder 

func (client ServiceHealthsClient) GetResponder(resp *http.Response) (result ServiceHealth, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ServiceHealthsClient) GetSender 

func (client ServiceHealthsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ServiceHealthsClient) List 

func (client ServiceHealthsClient) List(ctx context.Context, location string, filter string) (result ServiceHealthListPage, err error)

List get a list of all services health

location is location name. filter is oData filter parameter.

func (ServiceHealthsClient) ListComplete 

func (client ServiceHealthsClient) ListComplete(ctx context.Context, location string, filter string) (result ServiceHealthListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ServiceHealthsClient) ListPreparer 

func (client ServiceHealthsClient) ListPreparer(ctx context.Context, location string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (ServiceHealthsClient) ListResponder 

func (client ServiceHealthsClient) ListResponder(resp *http.Response) (result ServiceHealthList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ServiceHealthsClient) ListSender 

func (client ServiceHealthsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UsageMetrics 

type UsageMetrics struct {
	// Name - Name of the usage metric.
	Name *string `json:"name,omitempty"`
	// MetricsValue - List of usage metrics.
	MetricsValue *[]Metrics `json:"metricsValue,omitempty"`
}

UsageMetrics metrics of resource usage.

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.