Documentation ¶
Overview ¶
Package resourcehealth implements the Azure ARM Resourcehealth service API version 2017-07-01.
The Resource Health Client.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AvailabilityStateValues
- type AvailabilityStatus
- type AvailabilityStatusListResult
- type AvailabilityStatusListResultIterator
- func (iter *AvailabilityStatusListResultIterator) Next() error
- func (iter *AvailabilityStatusListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter AvailabilityStatusListResultIterator) NotDone() bool
- func (iter AvailabilityStatusListResultIterator) Response() AvailabilityStatusListResult
- func (iter AvailabilityStatusListResultIterator) Value() AvailabilityStatus
- type AvailabilityStatusListResultPage
- func (page *AvailabilityStatusListResultPage) Next() error
- func (page *AvailabilityStatusListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page AvailabilityStatusListResultPage) NotDone() bool
- func (page AvailabilityStatusListResultPage) Response() AvailabilityStatusListResult
- func (page AvailabilityStatusListResultPage) Values() []AvailabilityStatus
- type AvailabilityStatusProperties
- type AvailabilityStatusPropertiesRecentlyResolvedState
- type AvailabilityStatusesClient
- func (client AvailabilityStatusesClient) GetByResource(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatus, err error)
- func (client AvailabilityStatusesClient) GetByResourcePreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
- func (client AvailabilityStatusesClient) GetByResourceResponder(resp *http.Response) (result AvailabilityStatus, err error)
- func (client AvailabilityStatusesClient) GetByResourceSender(req *http.Request) (*http.Response, error)
- func (client AvailabilityStatusesClient) List(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultPage, err error)
- func (client AvailabilityStatusesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, filter string, expand string) (result AvailabilityStatusListResultPage, err error)
- func (client AvailabilityStatusesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
- func (client AvailabilityStatusesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string, expand string) (*http.Request, error)
- func (client AvailabilityStatusesClient) ListByResourceGroupResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)
- func (client AvailabilityStatusesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client AvailabilityStatusesClient) ListBySubscriptionID(ctx context.Context, filter string, expand string) (result AvailabilityStatusListResultPage, err error)
- func (client AvailabilityStatusesClient) ListBySubscriptionIDComplete(ctx context.Context, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
- func (client AvailabilityStatusesClient) ListBySubscriptionIDPreparer(ctx context.Context, filter string, expand string) (*http.Request, error)
- func (client AvailabilityStatusesClient) ListBySubscriptionIDResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)
- func (client AvailabilityStatusesClient) ListBySubscriptionIDSender(req *http.Request) (*http.Response, error)
- func (client AvailabilityStatusesClient) ListComplete(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
- func (client AvailabilityStatusesClient) ListPreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
- func (client AvailabilityStatusesClient) ListResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)
- func (client AvailabilityStatusesClient) ListSender(req *http.Request) (*http.Response, error)
- type BaseClient
- type ChildAvailabilityStatusesClient
- func (client ChildAvailabilityStatusesClient) GetByResource(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatus, err error)
- func (client ChildAvailabilityStatusesClient) GetByResourcePreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
- func (client ChildAvailabilityStatusesClient) GetByResourceResponder(resp *http.Response) (result AvailabilityStatus, err error)
- func (client ChildAvailabilityStatusesClient) GetByResourceSender(req *http.Request) (*http.Response, error)
- func (client ChildAvailabilityStatusesClient) List(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultPage, err error)
- func (client ChildAvailabilityStatusesClient) ListComplete(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
- func (client ChildAvailabilityStatusesClient) ListPreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
- func (client ChildAvailabilityStatusesClient) ListResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)
- func (client ChildAvailabilityStatusesClient) ListSender(req *http.Request) (*http.Response, error)
- type ChildResourcesClient
- func (client ChildResourcesClient) List(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultPage, err error)
- func (client ChildResourcesClient) ListComplete(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
- func (client ChildResourcesClient) ListPreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
- func (client ChildResourcesClient) ListResponder(resp *http.Response) (result AvailabilityStatusListResult, err error)
- func (client ChildResourcesClient) ListSender(req *http.Request) (*http.Response, error)
- type ErrorResponse
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ReasonChronicityTypes
- type RecommendedAction
- type ServiceImpactingEvent
- type ServiceImpactingEventIncidentProperties
- type ServiceImpactingEventStatus
Constants ¶
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 ... Available AvailabilityStateValues = "Available" Unavailable AvailabilityStateValues = "Unavailable" // Unknown ... Unknown AvailabilityStateValues = "Unknown" )
func PossibleAvailabilityStateValuesValues ¶
func PossibleAvailabilityStateValuesValues() []AvailabilityStateValues
PossibleAvailabilityStateValuesValues returns an array of possible values for the AvailabilityStateValues const type.
type AvailabilityStatus ¶
type AvailabilityStatus struct { autorest.Response `json:"-"` // ID - Azure Resource Manager Identity for the availabilityStatuses resource. ID *string `json:"id,omitempty"` // Name - current. Name *string `json:"name,omitempty"` // Type - Microsoft.ResourceHealth/AvailabilityStatuses. Type *string `json:"type,omitempty"` // Location - Azure Resource Manager geo location of the resource. Location *string `json:"location,omitempty"` // Properties - Properties of availability state. Properties *AvailabilityStatusProperties `json:"properties,omitempty"` }
AvailabilityStatus availabilityStatus of a resource.
type AvailabilityStatusListResult ¶
type AvailabilityStatusListResult struct { autorest.Response `json:"-"` // Value - The list of availabilityStatuses. Value *[]AvailabilityStatus `json:"value,omitempty"` // NextLink - The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. NextLink *string `json:"nextLink,omitempty"` }
AvailabilityStatusListResult the List availabilityStatus operation response.
func (AvailabilityStatusListResult) IsEmpty ¶
func (aslr AvailabilityStatusListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AvailabilityStatusListResultIterator ¶
type AvailabilityStatusListResultIterator struct {
// contains filtered or unexported fields
}
AvailabilityStatusListResultIterator provides access to a complete listing of AvailabilityStatus values.
func NewAvailabilityStatusListResultIterator ¶
func NewAvailabilityStatusListResultIterator(page AvailabilityStatusListResultPage) AvailabilityStatusListResultIterator
Creates a new instance of the AvailabilityStatusListResultIterator type.
func (*AvailabilityStatusListResultIterator) Next ¶
func (iter *AvailabilityStatusListResultIterator) 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. Deprecated: Use NextWithContext() instead.
func (*AvailabilityStatusListResultIterator) NextWithContext ¶
func (iter *AvailabilityStatusListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (AvailabilityStatusListResultIterator) NotDone ¶
func (iter AvailabilityStatusListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (AvailabilityStatusListResultIterator) Response ¶
func (iter AvailabilityStatusListResultIterator) Response() AvailabilityStatusListResult
Response returns the raw server response from the last page request.
func (AvailabilityStatusListResultIterator) Value ¶
func (iter AvailabilityStatusListResultIterator) Value() AvailabilityStatus
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type AvailabilityStatusListResultPage ¶
type AvailabilityStatusListResultPage struct {
// contains filtered or unexported fields
}
AvailabilityStatusListResultPage contains a page of AvailabilityStatus values.
func NewAvailabilityStatusListResultPage ¶
func NewAvailabilityStatusListResultPage(getNextPage func(context.Context, AvailabilityStatusListResult) (AvailabilityStatusListResult, error)) AvailabilityStatusListResultPage
Creates a new instance of the AvailabilityStatusListResultPage type.
func (*AvailabilityStatusListResultPage) Next ¶
func (page *AvailabilityStatusListResultPage) 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. Deprecated: Use NextWithContext() instead.
func (*AvailabilityStatusListResultPage) NextWithContext ¶
func (page *AvailabilityStatusListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (AvailabilityStatusListResultPage) NotDone ¶
func (page AvailabilityStatusListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (AvailabilityStatusListResultPage) Response ¶
func (page AvailabilityStatusListResultPage) Response() AvailabilityStatusListResult
Response returns the raw server response from the last page request.
func (AvailabilityStatusListResultPage) Values ¶
func (page AvailabilityStatusListResultPage) Values() []AvailabilityStatus
Values returns the slice of values for the current page or nil if there are no values.
type AvailabilityStatusProperties ¶
type AvailabilityStatusProperties struct { // AvailabilityState - Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event. Possible values include: 'Available', 'Unavailable', 'Unknown' AvailabilityState AvailabilityStateValues `json:"availabilityState,omitempty"` // Summary - Summary description of the availability status. Summary *string `json:"summary,omitempty"` // DetailedStatus - Details of the availability status. DetailedStatus *string `json:"detailedStatus,omitempty"` // ReasonType - When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ReasonType *string `json:"reasonType,omitempty"` // RootCauseAttributionTime - When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. RootCauseAttributionTime *date.Time `json:"rootCauseAttributionTime,omitempty"` // HealthEventType - In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. HealthEventType *string `json:"healthEventType,omitempty"` // HealthEventCause - In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. HealthEventCause *string `json:"healthEventCause,omitempty"` // HealthEventCategory - In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. HealthEventCategory *string `json:"healthEventCategory,omitempty"` // HealthEventID - It is a unique Id that identifies the event HealthEventID *string `json:"healthEventId,omitempty"` // ResolutionETA - When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ResolutionETA *date.Time `json:"resolutionETA,omitempty"` // OccuredTime - Timestamp for when last change in health status occurred. OccuredTime *date.Time `json:"occuredTime,omitempty"` // ReasonChronicity - Chronicity of the availability transition. Possible values include: 'Transient', 'Persistent' ReasonChronicity ReasonChronicityTypes `json:"reasonChronicity,omitempty"` // ReportedTime - Timestamp for when the health was last checked. ReportedTime *date.Time `json:"reportedTime,omitempty"` // RecentlyResolvedState - An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned RecentlyResolvedState *AvailabilityStatusPropertiesRecentlyResolvedState `json:"recentlyResolvedState,omitempty"` // RecommendedActions - Lists actions the user can take based on the current availabilityState of the resource. RecommendedActions *[]RecommendedAction `json:"recommendedActions,omitempty"` // ServiceImpactingEvents - Lists the service impacting events that may be affecting the health of the resource. ServiceImpactingEvents *[]ServiceImpactingEvent `json:"serviceImpactingEvents,omitempty"` }
AvailabilityStatusProperties properties of availability state.
type AvailabilityStatusPropertiesRecentlyResolvedState ¶
type AvailabilityStatusPropertiesRecentlyResolvedState struct { date.Time `json:"unavailableOccurredTime,omitempty"` // ResolvedTime - Timestamp when the availabilityState changes to Available. ResolvedTime *date.Time `json:"resolvedTime,omitempty"` UnavailabilitySummary *string `json:"unavailabilitySummary,omitempty"` }UnavailableOccurredTime *
AvailabilityStatusPropertiesRecentlyResolvedState an annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned
type AvailabilityStatusesClient ¶
type AvailabilityStatusesClient struct {
BaseClient
}
AvailabilityStatusesClient is the the Resource Health Client.
func NewAvailabilityStatusesClient ¶
func NewAvailabilityStatusesClient(subscriptionID string) AvailabilityStatusesClient
NewAvailabilityStatusesClient creates an instance of the AvailabilityStatusesClient client.
func NewAvailabilityStatusesClientWithBaseURI ¶
func NewAvailabilityStatusesClientWithBaseURI(baseURI string, subscriptionID string) AvailabilityStatusesClient
NewAvailabilityStatusesClientWithBaseURI creates an instance of the AvailabilityStatusesClient client.
func (AvailabilityStatusesClient) GetByResource ¶
func (client AvailabilityStatusesClient) GetByResource(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatus, err error)
GetByResource gets current availability status for a single resource Parameters: resourceURI - 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 - 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 - setting $expand=recommendedactions in url query expands the recommendedactions in the response.
func (AvailabilityStatusesClient) GetByResourcePreparer ¶
func (client AvailabilityStatusesClient) GetByResourcePreparer(ctx context.Context, 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(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultPage, 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 Parameters: resourceURI - 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 - 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 - setting $expand=recommendedactions in url query expands the recommendedactions in the response.
func (AvailabilityStatusesClient) ListByResourceGroup ¶
func (client AvailabilityStatusesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, filter string, expand string) (result AvailabilityStatusListResultPage, 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. Parameters: resourceGroupName - the name of the resource group. filter - 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 - setting $expand=recommendedactions in url query expands the recommendedactions in the response.
func (AvailabilityStatusesClient) ListByResourceGroupComplete ¶
func (client AvailabilityStatusesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (AvailabilityStatusesClient) ListByResourceGroupPreparer ¶
func (client AvailabilityStatusesClient) ListByResourceGroupPreparer(ctx context.Context, 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(ctx context.Context, filter string, expand string) (result AvailabilityStatusListResultPage, 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. Parameters: filter - 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 - setting $expand=recommendedactions in url query expands the recommendedactions in the response.
func (AvailabilityStatusesClient) ListBySubscriptionIDComplete ¶
func (client AvailabilityStatusesClient) ListBySubscriptionIDComplete(ctx context.Context, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
ListBySubscriptionIDComplete enumerates all values, automatically crossing page boundaries as required.
func (AvailabilityStatusesClient) ListBySubscriptionIDPreparer ¶
func (client AvailabilityStatusesClient) ListBySubscriptionIDPreparer(ctx context.Context, 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(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (AvailabilityStatusesClient) ListPreparer ¶
func (client AvailabilityStatusesClient) ListPreparer(ctx context.Context, 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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type BaseClient ¶
BaseClient is the base client for Resourcehealth.
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 ChildAvailabilityStatusesClient ¶
type ChildAvailabilityStatusesClient struct {
BaseClient
}
ChildAvailabilityStatusesClient is the the Resource Health Client.
func NewChildAvailabilityStatusesClient ¶
func NewChildAvailabilityStatusesClient(subscriptionID string) ChildAvailabilityStatusesClient
NewChildAvailabilityStatusesClient creates an instance of the ChildAvailabilityStatusesClient client.
func NewChildAvailabilityStatusesClientWithBaseURI ¶
func NewChildAvailabilityStatusesClientWithBaseURI(baseURI string, subscriptionID string) ChildAvailabilityStatusesClient
NewChildAvailabilityStatusesClientWithBaseURI creates an instance of the ChildAvailabilityStatusesClient client.
func (ChildAvailabilityStatusesClient) GetByResource ¶
func (client ChildAvailabilityStatusesClient) GetByResource(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatus, err error)
GetByResource gets current availability status for a single resource Parameters: resourceURI - the fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} filter - 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 - setting $expand=recommendedactions in url query expands the recommendedactions in the response.
func (ChildAvailabilityStatusesClient) GetByResourcePreparer ¶
func (client ChildAvailabilityStatusesClient) GetByResourcePreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
GetByResourcePreparer prepares the GetByResource request.
func (ChildAvailabilityStatusesClient) GetByResourceResponder ¶
func (client ChildAvailabilityStatusesClient) 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 (ChildAvailabilityStatusesClient) GetByResourceSender ¶
func (client ChildAvailabilityStatusesClient) 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 (ChildAvailabilityStatusesClient) List ¶
func (client ChildAvailabilityStatusesClient) List(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultPage, err error)
List lists the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status Parameters: resourceURI - the fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} filter - 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 - setting $expand=recommendedactions in url query expands the recommendedactions in the response.
func (ChildAvailabilityStatusesClient) ListComplete ¶
func (client ChildAvailabilityStatusesClient) ListComplete(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (ChildAvailabilityStatusesClient) ListPreparer ¶
func (client ChildAvailabilityStatusesClient) ListPreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (ChildAvailabilityStatusesClient) ListResponder ¶
func (client ChildAvailabilityStatusesClient) 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 (ChildAvailabilityStatusesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ChildResourcesClient ¶
type ChildResourcesClient struct {
BaseClient
}
ChildResourcesClient is the the Resource Health Client.
func NewChildResourcesClient ¶
func NewChildResourcesClient(subscriptionID string) ChildResourcesClient
NewChildResourcesClient creates an instance of the ChildResourcesClient client.
func NewChildResourcesClientWithBaseURI ¶
func NewChildResourcesClientWithBaseURI(baseURI string, subscriptionID string) ChildResourcesClient
NewChildResourcesClientWithBaseURI creates an instance of the ChildResourcesClient client.
func (ChildResourcesClient) List ¶
func (client ChildResourcesClient) List(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultPage, err error)
List lists the all the children and its current health status for a parent resource. Use the nextLink property in the response to get the next page of children current health Parameters: resourceURI - the fully qualified ID of the resource, including the resource name and resource type. Currently the API only support not nested parent resource type: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} filter - 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 - setting $expand=recommendedactions in url query expands the recommendedactions in the response.
func (ChildResourcesClient) ListComplete ¶
func (client ChildResourcesClient) ListComplete(ctx context.Context, resourceURI string, filter string, expand string) (result AvailabilityStatusListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (ChildResourcesClient) ListPreparer ¶
func (client ChildResourcesClient) ListPreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (ChildResourcesClient) ListResponder ¶
func (client ChildResourcesClient) 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 (ChildResourcesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ErrorResponse ¶
type ErrorResponse struct { // Code - READ-ONLY; The error code. Code *string `json:"code,omitempty"` // Message - READ-ONLY; The error message. Message *string `json:"message,omitempty"` // Details - READ-ONLY; The error details. Details *string `json:"details,omitempty"` }
ErrorResponse error details.
type Operation ¶
type Operation struct { // Name - Name of the operation. Name *string `json:"name,omitempty"` // Display - Properties of the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation operation available in the resourcehealth resource provider.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - Provider name. Provider *string `json:"provider,omitempty"` // Resource - Resource name. Resource *string `json:"resource,omitempty"` // Operation - Operation name. Operation *string `json:"operation,omitempty"` // Description - Description of the operation. Description *string `json:"description,omitempty"` }
OperationDisplay properties of the operation.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - List of operations available in the resourcehealth resource provider. Value *[]Operation `json:"value,omitempty"` }
OperationListResult lists the operations response.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the the Resource Health Client.
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List lists available operations for the resourcehealth resource provider
func (OperationsClient) ListPreparer ¶
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 ¶
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 ... Persistent ReasonChronicityTypes = "Persistent" // Transient ... Transient ReasonChronicityTypes = "Transient" )
func PossibleReasonChronicityTypesValues ¶
func PossibleReasonChronicityTypesValues() []ReasonChronicityTypes
PossibleReasonChronicityTypesValues returns an array of possible values for the ReasonChronicityTypes const type.
type RecommendedAction ¶
type RecommendedAction struct { // Action - Recommended action. Action *string `json:"action,omitempty"` // ActionURL - Link to the action ActionURL *string `json:"actionUrl,omitempty"` // ActionURLText - Substring of action, it describes which text should host the action url. ActionURLText *string `json:"actionUrlText,omitempty"` }
RecommendedAction lists actions the user can take based on the current availabilityState of the resource.
type ServiceImpactingEvent ¶
type ServiceImpactingEvent struct { // EventStartTime - Timestamp for when the event started. EventStartTime *date.Time `json:"eventStartTime,omitempty"` // EventStatusLastModifiedTime - Timestamp for when event was submitted/detected. EventStatusLastModifiedTime *date.Time `json:"eventStatusLastModifiedTime,omitempty"` // CorrelationID - Correlation id for the event CorrelationID *string `json:"correlationId,omitempty"` // Status - Status of the service impacting event. Status *ServiceImpactingEventStatus `json:"status,omitempty"` // IncidentProperties - Properties of the service impacting event. IncidentProperties *ServiceImpactingEventIncidentProperties `json:"incidentProperties,omitempty"` }
ServiceImpactingEvent lists the service impacting events that may be affecting the health of the resource.
type ServiceImpactingEventIncidentProperties ¶
type ServiceImpactingEventIncidentProperties struct { // Title - Title of the incident. Title *string `json:"title,omitempty"` // Service - Service impacted by the event. Service *string `json:"service,omitempty"` // Region - Region impacted by the event. Region *string `json:"region,omitempty"` // IncidentType - Type of Event. IncidentType *string `json:"incidentType,omitempty"` }
ServiceImpactingEventIncidentProperties properties of the service impacting event.
type ServiceImpactingEventStatus ¶
type ServiceImpactingEventStatus struct { // Value - Current status of the event Value *string `json:"value,omitempty"` }
ServiceImpactingEventStatus status of the service impacting event.