azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/resourcehealth/mgmt/2017-07-01/resourcehealth Index | Files | Directories

package resourcehealth

import "github.com/Azure/azure-sdk-for-go/services/resourcehealth/mgmt/2017-07-01/resourcehealth"

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

The Resource Health Client.

Index

Package Files

availabilitystatuses.go childavailabilitystatuses.go childresources.go client.go emergingissues.go models.go operations.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type AvailabilityStateValues Uses

type AvailabilityStateValues string

AvailabilityStateValues enumerates the values for availability state values.

const (
    // Available ...
    Available AvailabilityStateValues = "Available"
    // Unavailable ...
    Unavailable AvailabilityStateValues = "Unavailable"
    // Unknown ...
    Unknown AvailabilityStateValues = "Unknown"
)

func PossibleAvailabilityStateValuesValues Uses

func PossibleAvailabilityStateValuesValues() []AvailabilityStateValues

PossibleAvailabilityStateValuesValues returns an array of possible values for the AvailabilityStateValues const type.

type AvailabilityStatus Uses

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 Uses

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 Uses

func (aslr AvailabilityStatusListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AvailabilityStatusListResultIterator Uses

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

AvailabilityStatusListResultIterator provides access to a complete listing of AvailabilityStatus values.

func NewAvailabilityStatusListResultIterator Uses

func NewAvailabilityStatusListResultIterator(page AvailabilityStatusListResultPage) AvailabilityStatusListResultIterator

Creates a new instance of the AvailabilityStatusListResultIterator type.

func (*AvailabilityStatusListResultIterator) Next Uses

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 Uses

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 Uses

func (iter AvailabilityStatusListResultIterator) NotDone() bool

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

func (AvailabilityStatusListResultIterator) Response Uses

func (iter AvailabilityStatusListResultIterator) Response() AvailabilityStatusListResult

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

func (AvailabilityStatusListResultIterator) Value Uses

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 Uses

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

AvailabilityStatusListResultPage contains a page of AvailabilityStatus values.

func NewAvailabilityStatusListResultPage Uses

func NewAvailabilityStatusListResultPage(getNextPage func(context.Context, AvailabilityStatusListResult) (AvailabilityStatusListResult, error)) AvailabilityStatusListResultPage

Creates a new instance of the AvailabilityStatusListResultPage type.

func (*AvailabilityStatusListResultPage) Next Uses

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 Uses

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 Uses

func (page AvailabilityStatusListResultPage) NotDone() bool

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

func (AvailabilityStatusListResultPage) Response Uses

func (page AvailabilityStatusListResultPage) Response() AvailabilityStatusListResult

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

func (AvailabilityStatusListResultPage) Values Uses

func (page AvailabilityStatusListResultPage) Values() []AvailabilityStatus

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

type AvailabilityStatusProperties Uses

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 Uses

type AvailabilityStatusPropertiesRecentlyResolvedState struct {
    // UnavailableOccurredTime - Timestamp for when the availabilityState changed to Unavailable
    UnavailableOccurredTime *date.Time `json:"unavailableOccurredTime,omitempty"`
    // ResolvedTime - Timestamp when the availabilityState changes to Available.
    ResolvedTime *date.Time `json:"resolvedTime,omitempty"`
    // UnavailabilitySummary - Brief description of cause of the resource becoming unavailable.
    UnavailabilitySummary *string `json:"unavailabilitySummary,omitempty"`
}

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

type AvailabilityStatusesClient Uses

type AvailabilityStatusesClient struct {
    BaseClient
}

AvailabilityStatusesClient is the the Resource Health Client.

func NewAvailabilityStatusesClient Uses

func NewAvailabilityStatusesClient(subscriptionID string) AvailabilityStatusesClient

NewAvailabilityStatusesClient creates an instance of the AvailabilityStatusesClient client.

func NewAvailabilityStatusesClientWithBaseURI Uses

func NewAvailabilityStatusesClientWithBaseURI(baseURI string, subscriptionID string) AvailabilityStatusesClient

NewAvailabilityStatusesClientWithBaseURI creates an instance of the AvailabilityStatusesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AvailabilityStatusesClient) GetByResource Uses

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 Uses

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

GetByResourcePreparer prepares the GetByResource request.

func (AvailabilityStatusesClient) GetByResourceResponder Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AvailabilityStatusesClient) ListByResourceGroupResponder Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

ListBySubscriptionIDPreparer prepares the ListBySubscriptionID request.

func (AvailabilityStatusesClient) ListBySubscriptionIDResponder Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (AvailabilityStatusesClient) ListResponder Uses

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 Uses

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 AzureEntityResource Uses

type AzureEntityResource struct {
    // Etag - READ-ONLY; Resource Etag.
    Etag *string `json:"etag,omitempty"`
    // ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for a Azure Resource Manager resource with an etag.

type BaseClient Uses

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

BaseClient is the base client for Resourcehealth.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type ChildAvailabilityStatusesClient Uses

type ChildAvailabilityStatusesClient struct {
    BaseClient
}

ChildAvailabilityStatusesClient is the the Resource Health Client.

func NewChildAvailabilityStatusesClient Uses

func NewChildAvailabilityStatusesClient(subscriptionID string) ChildAvailabilityStatusesClient

NewChildAvailabilityStatusesClient creates an instance of the ChildAvailabilityStatusesClient client.

func NewChildAvailabilityStatusesClientWithBaseURI Uses

func NewChildAvailabilityStatusesClientWithBaseURI(baseURI string, subscriptionID string) ChildAvailabilityStatusesClient

NewChildAvailabilityStatusesClientWithBaseURI creates an instance of the ChildAvailabilityStatusesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ChildAvailabilityStatusesClient) GetByResource Uses

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 Uses

func (client ChildAvailabilityStatusesClient) GetByResourcePreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)

GetByResourcePreparer prepares the GetByResource request.

func (ChildAvailabilityStatusesClient) GetByResourceResponder Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (client ChildAvailabilityStatusesClient) ListPreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (ChildAvailabilityStatusesClient) ListResponder Uses

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 Uses

func (client ChildAvailabilityStatusesClient) 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 ChildResourcesClient Uses

type ChildResourcesClient struct {
    BaseClient
}

ChildResourcesClient is the the Resource Health Client.

func NewChildResourcesClient Uses

func NewChildResourcesClient(subscriptionID string) ChildResourcesClient

NewChildResourcesClient creates an instance of the ChildResourcesClient client.

func NewChildResourcesClientWithBaseURI Uses

func NewChildResourcesClientWithBaseURI(baseURI string, subscriptionID string) ChildResourcesClient

NewChildResourcesClientWithBaseURI creates an instance of the ChildResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ChildResourcesClient) List Uses

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 Uses

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 Uses

func (client ChildResourcesClient) ListPreparer(ctx context.Context, resourceURI string, filter string, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (ChildResourcesClient) ListResponder Uses

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 Uses

func (client ChildResourcesClient) 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 EmergingIssue Uses

type EmergingIssue struct {
    // RefreshTimestamp - Timestamp for when last time refreshed for ongoing emerging issue.
    RefreshTimestamp *date.Time `json:"refreshTimestamp,omitempty"`
    // StatusBanners - The list of emerging issues of banner type.
    StatusBanners *[]StatusBanner `json:"statusBanners,omitempty"`
    // StatusActiveEvents - The list of emerging issues of active event type.
    StatusActiveEvents *[]StatusActiveEvent `json:"statusActiveEvents,omitempty"`
}

EmergingIssue on-going emerging issue from azure status.

type EmergingIssueImpact Uses

type EmergingIssueImpact struct {
    // ID - The impacted service id.
    ID  *string `json:"id,omitempty"`
    // Name - The impacted service name.
    Name *string `json:"name,omitempty"`
    // Regions - The list of impacted regions for corresponding emerging issues.
    Regions *[]ImpactedRegion `json:"regions,omitempty"`
}

EmergingIssueImpact object of the emerging issue impact on services and regions.

type EmergingIssueListResult Uses

type EmergingIssueListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of emerging issues.
    Value *[]EmergingIssuesGetResult `json:"value,omitempty"`
    // NextLink - The link used to get the next page of emerging issues.
    NextLink *string `json:"nextLink,omitempty"`
}

EmergingIssueListResult the list of emerging issues.

func (EmergingIssueListResult) IsEmpty Uses

func (eilr EmergingIssueListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EmergingIssueListResultIterator Uses

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

EmergingIssueListResultIterator provides access to a complete listing of EmergingIssuesGetResult values.

func NewEmergingIssueListResultIterator Uses

func NewEmergingIssueListResultIterator(page EmergingIssueListResultPage) EmergingIssueListResultIterator

Creates a new instance of the EmergingIssueListResultIterator type.

func (*EmergingIssueListResultIterator) Next Uses

func (iter *EmergingIssueListResultIterator) 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 (*EmergingIssueListResultIterator) NextWithContext Uses

func (iter *EmergingIssueListResultIterator) 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 (EmergingIssueListResultIterator) NotDone Uses

func (iter EmergingIssueListResultIterator) NotDone() bool

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

func (EmergingIssueListResultIterator) Response Uses

func (iter EmergingIssueListResultIterator) Response() EmergingIssueListResult

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

func (EmergingIssueListResultIterator) Value Uses

func (iter EmergingIssueListResultIterator) Value() EmergingIssuesGetResult

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

type EmergingIssueListResultPage Uses

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

EmergingIssueListResultPage contains a page of EmergingIssuesGetResult values.

func NewEmergingIssueListResultPage Uses

func NewEmergingIssueListResultPage(getNextPage func(context.Context, EmergingIssueListResult) (EmergingIssueListResult, error)) EmergingIssueListResultPage

Creates a new instance of the EmergingIssueListResultPage type.

func (*EmergingIssueListResultPage) Next Uses

func (page *EmergingIssueListResultPage) 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 (*EmergingIssueListResultPage) NextWithContext Uses

func (page *EmergingIssueListResultPage) 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 (EmergingIssueListResultPage) NotDone Uses

func (page EmergingIssueListResultPage) NotDone() bool

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

func (EmergingIssueListResultPage) Response Uses

func (page EmergingIssueListResultPage) Response() EmergingIssueListResult

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

func (EmergingIssueListResultPage) Values Uses

func (page EmergingIssueListResultPage) Values() []EmergingIssuesGetResult

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

type EmergingIssuesClient Uses

type EmergingIssuesClient struct {
    BaseClient
}

EmergingIssuesClient is the the Resource Health Client.

func NewEmergingIssuesClient Uses

func NewEmergingIssuesClient(subscriptionID string) EmergingIssuesClient

NewEmergingIssuesClient creates an instance of the EmergingIssuesClient client.

func NewEmergingIssuesClientWithBaseURI Uses

func NewEmergingIssuesClientWithBaseURI(baseURI string, subscriptionID string) EmergingIssuesClient

NewEmergingIssuesClientWithBaseURI creates an instance of the EmergingIssuesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (EmergingIssuesClient) Get Uses

func (client EmergingIssuesClient) Get(ctx context.Context) (result EmergingIssuesGetResult, err error)

Get gets Azure services' emerging issues.

func (EmergingIssuesClient) GetPreparer Uses

func (client EmergingIssuesClient) GetPreparer(ctx context.Context) (*http.Request, error)

GetPreparer prepares the Get request.

func (EmergingIssuesClient) GetResponder Uses

func (client EmergingIssuesClient) GetResponder(resp *http.Response) (result EmergingIssuesGetResult, err error)

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

func (EmergingIssuesClient) GetSender Uses

func (client EmergingIssuesClient) 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 (EmergingIssuesClient) List Uses

func (client EmergingIssuesClient) List(ctx context.Context) (result EmergingIssueListResultPage, err error)

List lists Azure services' emerging issues.

func (EmergingIssuesClient) ListComplete Uses

func (client EmergingIssuesClient) ListComplete(ctx context.Context) (result EmergingIssueListResultIterator, err error)

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

func (EmergingIssuesClient) ListPreparer Uses

func (client EmergingIssuesClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (EmergingIssuesClient) ListResponder Uses

func (client EmergingIssuesClient) ListResponder(resp *http.Response) (result EmergingIssueListResult, err error)

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

func (EmergingIssuesClient) ListSender Uses

func (client EmergingIssuesClient) 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 EmergingIssuesGetResult Uses

type EmergingIssuesGetResult struct {
    autorest.Response `json:"-"`
    // EmergingIssue - The emerging issue entity properties.
    *EmergingIssue `json:"properties,omitempty"`
    // ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    Type *string `json:"type,omitempty"`
}

EmergingIssuesGetResult the Get EmergingIssues operation response.

func (EmergingIssuesGetResult) MarshalJSON Uses

func (eigr EmergingIssuesGetResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EmergingIssuesGetResult.

func (*EmergingIssuesGetResult) UnmarshalJSON Uses

func (eigr *EmergingIssuesGetResult) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EmergingIssuesGetResult struct.

type ErrorResponse Uses

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 ImpactedRegion Uses

type ImpactedRegion struct {
    // ID - The impacted region id.
    ID  *string `json:"id,omitempty"`
    // Name - The impacted region name.
    Name *string `json:"name,omitempty"`
}

ImpactedRegion object of impacted region.

type Operation Uses

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 Uses

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 Uses

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 Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the the Resource Health Client.

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List Uses

func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)

List lists available operations for the resourcehealth resource provider

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

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 ProxyResource Uses

type ProxyResource struct {
    // ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

type ReasonChronicityTypes Uses

type ReasonChronicityTypes string

ReasonChronicityTypes enumerates the values for reason chronicity types.

const (
    // Persistent ...
    Persistent ReasonChronicityTypes = "Persistent"
    // Transient ...
    Transient ReasonChronicityTypes = "Transient"
)

func PossibleReasonChronicityTypesValues Uses

func PossibleReasonChronicityTypesValues() []ReasonChronicityTypes

PossibleReasonChronicityTypesValues returns an array of possible values for the ReasonChronicityTypes const type.

type RecommendedAction Uses

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 Resource Uses

type Resource struct {
    // ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    Type *string `json:"type,omitempty"`
}

Resource ...

type ServiceImpactingEvent Uses

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 Uses

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 Uses

type ServiceImpactingEventStatus struct {
    // Value - Current status of the event
    Value *string `json:"value,omitempty"`
}

ServiceImpactingEventStatus status of the service impacting event.

type SeverityValues Uses

type SeverityValues string

SeverityValues enumerates the values for severity values.

const (
    // Error ...
    Error SeverityValues = "Error"
    // Information ...
    Information SeverityValues = "Information"
    // Warning ...
    Warning SeverityValues = "Warning"
)

func PossibleSeverityValuesValues Uses

func PossibleSeverityValuesValues() []SeverityValues

PossibleSeverityValuesValues returns an array of possible values for the SeverityValues const type.

type StageValues Uses

type StageValues string

StageValues enumerates the values for stage values.

const (
    // Active ...
    Active StageValues = "Active"
    // Archived ...
    Archived StageValues = "Archived"
    // Resolve ...
    Resolve StageValues = "Resolve"
)

func PossibleStageValuesValues Uses

func PossibleStageValuesValues() []StageValues

PossibleStageValuesValues returns an array of possible values for the StageValues const type.

type StatusActiveEvent Uses

type StatusActiveEvent struct {
    // Title - The active event title.
    Title *string `json:"title,omitempty"`
    // Description - The details of active event.
    Description *string `json:"description,omitempty"`
    // TrackingID - The tracking id of this active event.
    TrackingID *string `json:"trackingId,omitempty"`
    // StartTime - The impact start time on this active event.
    StartTime *date.Time `json:"startTime,omitempty"`
    // Cloud - The cloud type of this active event.
    Cloud *string `json:"cloud,omitempty"`
    // Severity - The severity level of this active event. Possible values include: 'Information', 'Warning', 'Error'
    Severity SeverityValues `json:"severity,omitempty"`
    // Stage - The stage of this active event. Possible values include: 'Active', 'Resolve', 'Archived'
    Stage StageValues `json:"stage,omitempty"`
    // Published - The boolean value of this active event if published or not.
    Published *bool `json:"published,omitempty"`
    // LastModifiedTime - The last time modified on this banner.
    LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
    // Impacts - The list of emerging issues impacts.
    Impacts *[]EmergingIssueImpact `json:"impacts,omitempty"`
}

StatusActiveEvent active event type of emerging issue.

type StatusBanner Uses

type StatusBanner struct {
    // Title - The banner title.
    Title *string `json:"title,omitempty"`
    // Message - The details of banner.
    Message *string `json:"message,omitempty"`
    // Cloud - The cloud type of this banner.
    Cloud *string `json:"cloud,omitempty"`
    // LastModifiedTime - The last time modified on this banner.
    LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
}

StatusBanner banner type of emerging issue.

type TrackedResource Uses

type TrackedResource struct {
    // Tags - Resource tags.
    Tags map[string]*string `json:"tags"`
    // Location - The geo-location where the resource lives
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON Uses

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

Directories

PathSynopsis
resourcehealthapi

Package resourcehealth imports 9 packages (graph) and is imported by 4 packages. Updated 2020-02-17. Refresh now. Tools for package owners.