resourcehealth

package
v11.1.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 6, 2017 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package resourcehealth implements the Azure ARM Resourcehealth service API version 2017-07-01.

The Resource Health Client.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Resourcehealth
	DefaultBaseURI = "https://management.azure.com"
)

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 AvailabilityStateValues 

type AvailabilityStateValues string

AvailabilityStateValues enumerates the values for availability state values. 

const (
	// Available specifies the available state for availability state values.
	Available AvailabilityStateValues = "Available"
	// Unavailable specifies the unavailable state for availability state values.
	Unavailable AvailabilityStateValues = "Unavailable"
	// Unknown specifies the unknown state for availability state values.
	Unknown AvailabilityStateValues = "Unknown"
)

type AvailabilityStatus 

type AvailabilityStatus struct {
	autorest.Response `json:"-"`
	ID                *string                       `json:"id,omitempty"`
	Name              *string                       `json:"name,omitempty"`
	Type              *string                       `json:"type,omitempty"`
	Location          *string                       `json:"location,omitempty"`
	Properties        *AvailabilityStatusProperties `json:"properties,omitempty"`
}

AvailabilityStatus is availabilityStatus of a resource.

type AvailabilityStatusListResult 

type AvailabilityStatusListResult struct {
	autorest.Response `json:"-"`
	Value             *[]AvailabilityStatus `json:"value,omitempty"`
	NextLink          *string               `json:"nextLink,omitempty"`
}

AvailabilityStatusListResult is the List availabilityStatus operation response.

func (AvailabilityStatusListResult) AvailabilityStatusListResultPreparer 

func (client AvailabilityStatusListResult) AvailabilityStatusListResultPreparer() (*http.Request, error)

AvailabilityStatusListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type AvailabilityStatusProperties 

type AvailabilityStatusProperties struct {
	AvailabilityState        AvailabilityStateValues                            `json:"availabilityState,omitempty"`
	Summary                  *string                                            `json:"summary,omitempty"`
	DetailedStatus           *string                                            `json:"detailedStatus,omitempty"`
	ReasonType               *string                                            `json:"reasonType,omitempty"`
	RootCauseAttributionTime *date.Time                                         `json:"rootCauseAttributionTime,omitempty"`
	HealthEventType          *string                                            `json:"healthEventType,omitempty"`
	HealthEventCause         *string                                            `json:"healthEventCause,omitempty"`
	HealthEventCategory      *string                                            `json:"healthEventCategory,omitempty"`
	HealthEventID            *string                                            `json:"healthEventId,omitempty"`
	ResolutionETA            *date.Time                                         `json:"resolutionETA,omitempty"`
	OccuredTime              *date.Time                                         `json:"occuredTime,omitempty"`
	ReasonChronicity         ReasonChronicityTypes                              `json:"reasonChronicity,omitempty"`
	ReportedTime             *date.Time                                         `json:"reportedTime,omitempty"`
	RecentlyResolvedState    *AvailabilityStatusPropertiesRecentlyResolvedState `json:"recentlyResolvedState,omitempty"`
	RecommendedActions       *[]RecommendedAction                               `json:"recommendedActions,omitempty"`
	ServiceImpactingEvents   *[]ServiceImpactingEvent                           `json:"serviceImpactingEvents,omitempty"`
}

AvailabilityStatusProperties is properties of availability state.

type AvailabilityStatusPropertiesRecentlyResolvedState 

type AvailabilityStatusPropertiesRecentlyResolvedState struct {
	UnavailableOccurredTime *date.Time `json:"unavailableOccurredTime,omitempty"`
	ResolvedTime            *date.Time `json:"resolvedTime,omitempty"`
	UnavailabilitySummary   *string    `json:"unavailabilitySummary,omitempty"`
}

AvailabilityStatusPropertiesRecentlyResolvedState is an annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned

type AvailabilityStatusesClient 

type AvailabilityStatusesClient struct {
	ManagementClient
}

AvailabilityStatusesClient is the the Resource Health Client.

func NewAvailabilityStatusesClient 

func NewAvailabilityStatusesClient(subscriptionID string, resourceType string) AvailabilityStatusesClient

NewAvailabilityStatusesClient creates an instance of the AvailabilityStatusesClient client.

func NewAvailabilityStatusesClientWithBaseURI 

func NewAvailabilityStatusesClientWithBaseURI(baseURI string, subscriptionID string, resourceType string) AvailabilityStatusesClient

NewAvailabilityStatusesClientWithBaseURI creates an instance of the AvailabilityStatusesClient client.

func (AvailabilityStatusesClient) GetByResource 

func (client AvailabilityStatusesClient) GetByResource(resourceURI string, filter string, expand string) (result AvailabilityStatus, err error)

GetByResource gets current availability status for a single resource

resourceURI is the fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} filter is the filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN expand is setting $expand=recommendedactions in url query expands the recommendedactions in the response.

func (AvailabilityStatusesClient) GetByResourcePreparer 

func (client AvailabilityStatusesClient) GetByResourcePreparer(resourceURI string, filter string, expand string) (*http.Request, error)

GetByResourcePreparer prepares the GetByResource request.

func (AvailabilityStatusesClient) GetByResourceResponder 

func (client AvailabilityStatusesClient) GetByResourceResponder(resp *http.Response) (result AvailabilityStatus, err error)

GetByResourceResponder handles the response to the GetByResource request. The method always closes the http.Response Body.

func (AvailabilityStatusesClient) GetByResourceSender 

func (client AvailabilityStatusesClient) GetByResourceSender(req *http.Request) (*http.Response, error)

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

func (AvailabilityStatusesClient) List 

func (client AvailabilityStatusesClient) List(resourceURI string, filter string, expand string) (result AvailabilityStatusListResult, err error)

List lists all historical availability transitions and impacting events for a single resource. Use the nextLink property in the response to get the next page of availability status

resourceURI is the fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} filter is the filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN expand is setting $expand=recommendedactions in url query expands the recommendedactions in the response.

func (AvailabilityStatusesClient) ListByResourceGroup 

func (client AvailabilityStatusesClient) ListByResourceGroup(resourceGroupName string, filter string, expand string) (result AvailabilityStatusListResult, err error)

ListByResourceGroup lists the current availability status for all the resources in the resource group. Use the nextLink property in the response to get the next page of availability statuses.

resourceGroupName is the name of the resource group. filter is the filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN expand is setting $expand=recommendedactions in url query expands the recommendedactions in the response.

func (AvailabilityStatusesClient) ListByResourceGroupComplete 

func (client AvailabilityStatusesClient) ListByResourceGroupComplete(resourceGroupName string, filter string, expand string, cancel <-chan struct{}) (<-chan AvailabilityStatus, <-chan error)

ListByResourceGroupComplete gets all elements from the list without paging.

func (AvailabilityStatusesClient) ListByResourceGroupNextResults 

func (client AvailabilityStatusesClient) ListByResourceGroupNextResults(lastResults AvailabilityStatusListResult) (result AvailabilityStatusListResult, err error)

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (AvailabilityStatusesClient) ListByResourceGroupPreparer 

func (client AvailabilityStatusesClient) ListByResourceGroupPreparer(resourceGroupName string, filter string, expand string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AvailabilityStatusesClient) ListByResourceGroupResponder 

func (client AvailabilityStatusesClient) ListByResourceGroupResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (AvailabilityStatusesClient) ListByResourceGroupSender 

func (client AvailabilityStatusesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (AvailabilityStatusesClient) ListBySubscriptionID 

func (client AvailabilityStatusesClient) ListBySubscriptionID(filter string, expand string) (result AvailabilityStatusListResult, err error)

ListBySubscriptionID lists the current availability status for all the resources in the subscription. Use the nextLink property in the response to get the next page of availability statuses.

filter is the filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN expand is setting $expand=recommendedactions in url query expands the recommendedactions in the response.

func (AvailabilityStatusesClient) ListBySubscriptionIDComplete 

func (client AvailabilityStatusesClient) ListBySubscriptionIDComplete(filter string, expand string, cancel <-chan struct{}) (<-chan AvailabilityStatus, <-chan error)

ListBySubscriptionIDComplete gets all elements from the list without paging.

func (AvailabilityStatusesClient) ListBySubscriptionIDNextResults 

func (client AvailabilityStatusesClient) ListBySubscriptionIDNextResults(lastResults AvailabilityStatusListResult) (result AvailabilityStatusListResult, err error)

ListBySubscriptionIDNextResults retrieves the next set of results, if any.

func (AvailabilityStatusesClient) ListBySubscriptionIDPreparer 

func (client AvailabilityStatusesClient) ListBySubscriptionIDPreparer(filter string, expand string) (*http.Request, error)

ListBySubscriptionIDPreparer prepares the ListBySubscriptionID request.

func (AvailabilityStatusesClient) ListBySubscriptionIDResponder 

func (client AvailabilityStatusesClient) ListBySubscriptionIDResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)

ListBySubscriptionIDResponder handles the response to the ListBySubscriptionID request. The method always closes the http.Response Body.

func (AvailabilityStatusesClient) ListBySubscriptionIDSender 

func (client AvailabilityStatusesClient) ListBySubscriptionIDSender(req *http.Request) (*http.Response, error)

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

func (AvailabilityStatusesClient) ListComplete 

func (client AvailabilityStatusesClient) ListComplete(resourceURI string, filter string, expand string, cancel <-chan struct{}) (<-chan AvailabilityStatus, <-chan error)

ListComplete gets all elements from the list without paging.

func (AvailabilityStatusesClient) ListNextResults 

func (client AvailabilityStatusesClient) ListNextResults(lastResults AvailabilityStatusListResult) (result AvailabilityStatusListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (AvailabilityStatusesClient) ListPreparer 

func (client AvailabilityStatusesClient) ListPreparer(resourceURI string, filter string, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (AvailabilityStatusesClient) ListResponder 

func (client AvailabilityStatusesClient) ListResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)

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

func (AvailabilityStatusesClient) ListSender 

func (client AvailabilityStatusesClient) 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 ErrorResponse 

type ErrorResponse struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Details *string `json:"details,omitempty"`
}

ErrorResponse is error details.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
	ResourceType   string
}

ManagementClient is the base client for Resourcehealth.

func New 

func New(subscriptionID string, resourceType string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string, resourceType string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type Operation 

type Operation struct {
	Name    *string           `json:"name,omitempty"`
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation is operation available in the resourcehealth resource provider.

type OperationDisplay 

type OperationDisplay struct {
	Provider    *string `json:"provider,omitempty"`
	Resource    *string `json:"resource,omitempty"`
	Operation   *string `json:"operation,omitempty"`
	Description *string `json:"description,omitempty"`
}

OperationDisplay is properties of the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Operation `json:"value,omitempty"`
}

OperationListResult is lists the operations response.

type OperationsClient 

type OperationsClient struct {
	ManagementClient
}

OperationsClient is the the Resource Health Client.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string, resourceType string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string, resourceType string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List() (result OperationListResult, err error)

List lists available operations for the resourcehealth resource provider

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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 ReasonChronicityTypes 

type ReasonChronicityTypes string

ReasonChronicityTypes enumerates the values for reason chronicity types. 

const (
	// Persistent specifies the persistent state for reason chronicity types.
	Persistent ReasonChronicityTypes = "Persistent"
	// Transient specifies the transient state for reason chronicity types.
	Transient ReasonChronicityTypes = "Transient"
)

type RecommendedAction 

type RecommendedAction struct {
	Action        *string `json:"action,omitempty"`
	ActionURL     *string `json:"actionUrl,omitempty"`
	ActionURLText *string `json:"actionUrlText,omitempty"`
}

RecommendedAction is lists actions the user can take based on the current availabilityState of the resource.

type ServiceImpactingEvent 

type ServiceImpactingEvent struct {
	EventStartTime              *date.Time                               `json:"eventStartTime,omitempty"`
	EventStatusLastModifiedTime *date.Time                               `json:"eventStatusLastModifiedTime,omitempty"`
	CorrelationID               *string                                  `json:"correlationId,omitempty"`
	Status                      *ServiceImpactingEventStatus             `json:"status,omitempty"`
	IncidentProperties          *ServiceImpactingEventIncidentProperties `json:"incidentProperties,omitempty"`
}

ServiceImpactingEvent is lists the service impacting events that may be affecting the health of the resource.

type ServiceImpactingEventIncidentProperties 

type ServiceImpactingEventIncidentProperties struct {
	Title        *string `json:"title,omitempty"`
	Service      *string `json:"service,omitempty"`
	Region       *string `json:"region,omitempty"`
	IncidentType *string `json:"incidentType,omitempty"`
}

ServiceImpactingEventIncidentProperties is properties of the service impacting event.

type ServiceImpactingEventStatus 

type ServiceImpactingEventStatus struct {
	Value *string `json:"value,omitempty"`
}

ServiceImpactingEventStatus is status of the service impacting event.

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.