azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/portal/mgmt/2019-01-01-preview/portal Index | Files | Directories

package portal

import "github.com/Azure/azure-sdk-for-go/services/preview/portal/mgmt/2019-01-01-preview/portal"

Package portal implements the Azure ARM Portal service API version 2019-01-01-preview.

Allows creation and deletion of Azure Shared Dashboards.

Index

Package Files

client.go dashboards.go models.go operations.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Portal
    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 BaseClient Uses

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

BaseClient is the base client for Portal.

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.

type Dashboard Uses

type Dashboard struct {
    autorest.Response `json:"-"`
    // DashboardProperties - The shared dashboard properties.
    *DashboardProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; Resource Id
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type
    Type *string `json:"type,omitempty"`
    // Location - Resource location
    Location *string `json:"location,omitempty"`
    // Tags - Resource tags
    Tags map[string]*string `json:"tags"`
}

Dashboard the shared dashboard resource definition.

func (Dashboard) MarshalJSON Uses

func (d Dashboard) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Dashboard.

func (*Dashboard) UnmarshalJSON Uses

func (d *Dashboard) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Dashboard struct.

type DashboardLens Uses

type DashboardLens struct {
    // Order - The lens order.
    Order *int32 `json:"order,omitempty"`
    // Parts - The dashboard parts.
    Parts map[string]*DashboardParts `json:"parts"`
    // Metadata - The dashboard len's metadata.
    Metadata map[string]interface{} `json:"metadata"`
}

DashboardLens a dashboard lens.

func (DashboardLens) MarshalJSON Uses

func (dl DashboardLens) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DashboardLens.

type DashboardListResult Uses

type DashboardListResult struct {
    autorest.Response `json:"-"`
    // Value - The array of custom resource provider manifests.
    Value *[]Dashboard `json:"value,omitempty"`
    // NextLink - The URL to use for getting the next set of results.
    NextLink *string `json:"nextLink,omitempty"`
}

DashboardListResult list of dashboards.

func (DashboardListResult) IsEmpty Uses

func (dlr DashboardListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DashboardListResultIterator Uses

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

DashboardListResultIterator provides access to a complete listing of Dashboard values.

func NewDashboardListResultIterator Uses

func NewDashboardListResultIterator(page DashboardListResultPage) DashboardListResultIterator

Creates a new instance of the DashboardListResultIterator type.

func (*DashboardListResultIterator) Next Uses

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

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

func (iter DashboardListResultIterator) NotDone() bool

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

func (DashboardListResultIterator) Response Uses

func (iter DashboardListResultIterator) Response() DashboardListResult

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

func (DashboardListResultIterator) Value Uses

func (iter DashboardListResultIterator) Value() Dashboard

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

type DashboardListResultPage Uses

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

DashboardListResultPage contains a page of Dashboard values.

func NewDashboardListResultPage Uses

func NewDashboardListResultPage(getNextPage func(context.Context, DashboardListResult) (DashboardListResult, error)) DashboardListResultPage

Creates a new instance of the DashboardListResultPage type.

func (*DashboardListResultPage) Next Uses

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

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

func (page DashboardListResultPage) NotDone() bool

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

func (DashboardListResultPage) Response Uses

func (page DashboardListResultPage) Response() DashboardListResult

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

func (DashboardListResultPage) Values Uses

func (page DashboardListResultPage) Values() []Dashboard

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

type DashboardParts Uses

type DashboardParts struct {
    // Position - The dashboard's part position.
    Position *DashboardPartsPosition `json:"position,omitempty"`
    // Metadata - The dashboard part's metadata.
    Metadata map[string]interface{} `json:"metadata"`
}

DashboardParts a dashboard part.

func (DashboardParts) MarshalJSON Uses

func (dp DashboardParts) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DashboardParts.

type DashboardPartsPosition Uses

type DashboardPartsPosition struct {
    // X - The dashboard's part x coordinate.
    X   *float64 `json:"x,omitempty"`
    // Y - The dashboard's part y coordinate.
    Y   *float64 `json:"y,omitempty"`
    // RowSpan - The dashboard's part row span.
    RowSpan *float64 `json:"rowSpan,omitempty"`
    // ColSpan - The dashboard's part column span.
    ColSpan *float64 `json:"colSpan,omitempty"`
    // Metadata - The dashboard part's metadata.
    Metadata map[string]interface{} `json:"metadata"`
}

DashboardPartsPosition the dashboard's part position.

func (DashboardPartsPosition) MarshalJSON Uses

func (dp DashboardPartsPosition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DashboardPartsPosition.

type DashboardProperties Uses

type DashboardProperties struct {
    // Lenses - The dashboard lenses.
    Lenses map[string]*DashboardLens `json:"lenses"`
    // Metadata - The dashboard metadata.
    Metadata map[string]interface{} `json:"metadata"`
}

DashboardProperties the shared dashboard properties.

func (DashboardProperties) MarshalJSON Uses

func (dp DashboardProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DashboardProperties.

type DashboardsClient Uses

type DashboardsClient struct {
    BaseClient
}

DashboardsClient is the allows creation and deletion of Azure Shared Dashboards.

func NewDashboardsClient Uses

func NewDashboardsClient(subscriptionID string) DashboardsClient

NewDashboardsClient creates an instance of the DashboardsClient client.

func NewDashboardsClientWithBaseURI Uses

func NewDashboardsClientWithBaseURI(baseURI string, subscriptionID string) DashboardsClient

NewDashboardsClientWithBaseURI creates an instance of the DashboardsClient client.

func (DashboardsClient) CreateOrUpdate Uses

func (client DashboardsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, dashboardName string, dashboard Dashboard) (result Dashboard, err error)

CreateOrUpdate creates or updates a Dashboard. Parameters: resourceGroupName - the name of the resource group. dashboardName - the name of the dashboard. dashboard - the parameters required to create or update a dashboard.

func (DashboardsClient) CreateOrUpdatePreparer Uses

func (client DashboardsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, dashboardName string, dashboard Dashboard) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DashboardsClient) CreateOrUpdateResponder Uses

func (client DashboardsClient) CreateOrUpdateResponder(resp *http.Response) (result Dashboard, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (DashboardsClient) CreateOrUpdateSender Uses

func (client DashboardsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (DashboardsClient) Delete Uses

func (client DashboardsClient) Delete(ctx context.Context, resourceGroupName string, dashboardName string) (result autorest.Response, err error)

Delete deletes the Dashboard. Parameters: resourceGroupName - the name of the resource group. dashboardName - the name of the dashboard.

func (DashboardsClient) DeletePreparer Uses

func (client DashboardsClient) DeletePreparer(ctx context.Context, resourceGroupName string, dashboardName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DashboardsClient) DeleteResponder Uses

func (client DashboardsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (DashboardsClient) DeleteSender Uses

func (client DashboardsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (DashboardsClient) Get Uses

func (client DashboardsClient) Get(ctx context.Context, resourceGroupName string, dashboardName string) (result Dashboard, err error)

Get gets the Dashboard. Parameters: resourceGroupName - the name of the resource group. dashboardName - the name of the dashboard.

func (DashboardsClient) GetPreparer Uses

func (client DashboardsClient) GetPreparer(ctx context.Context, resourceGroupName string, dashboardName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DashboardsClient) GetResponder Uses

func (client DashboardsClient) GetResponder(resp *http.Response) (result Dashboard, err error)

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

func (DashboardsClient) GetSender Uses

func (client DashboardsClient) 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 (DashboardsClient) ListByResourceGroup Uses

func (client DashboardsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DashboardListResultPage, err error)

ListByResourceGroup gets all the Dashboards within a resource group. Parameters: resourceGroupName - the name of the resource group.

func (DashboardsClient) ListByResourceGroupComplete Uses

func (client DashboardsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DashboardListResultIterator, err error)

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

func (DashboardsClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DashboardsClient) ListByResourceGroupResponder Uses

func (client DashboardsClient) ListByResourceGroupResponder(resp *http.Response) (result DashboardListResult, err error)

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

func (DashboardsClient) ListByResourceGroupSender Uses

func (client DashboardsClient) 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 (DashboardsClient) ListBySubscription Uses

func (client DashboardsClient) ListBySubscription(ctx context.Context) (result DashboardListResultPage, err error)

ListBySubscription gets all the dashboards within a subscription.

func (DashboardsClient) ListBySubscriptionComplete Uses

func (client DashboardsClient) ListBySubscriptionComplete(ctx context.Context) (result DashboardListResultIterator, err error)

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

func (DashboardsClient) ListBySubscriptionPreparer Uses

func (client DashboardsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (DashboardsClient) ListBySubscriptionResponder Uses

func (client DashboardsClient) ListBySubscriptionResponder(resp *http.Response) (result DashboardListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (DashboardsClient) ListBySubscriptionSender Uses

func (client DashboardsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (DashboardsClient) Update Uses

func (client DashboardsClient) Update(ctx context.Context, resourceGroupName string, dashboardName string, dashboard PatchableDashboard) (result Dashboard, err error)

Update updates an existing Dashboard. Parameters: resourceGroupName - the name of the resource group. dashboardName - the name of the dashboard. dashboard - the updatable fields of a Dashboard.

func (DashboardsClient) UpdatePreparer Uses

func (client DashboardsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, dashboardName string, dashboard PatchableDashboard) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DashboardsClient) UpdateResponder Uses

func (client DashboardsClient) UpdateResponder(resp *http.Response) (result Dashboard, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (DashboardsClient) UpdateSender Uses

func (client DashboardsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type ErrorDefinition Uses

type ErrorDefinition struct {
    // Code - READ-ONLY; Service specific error code which serves as the substatus for the HTTP error code.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; Description of the error.
    Message *string `json:"message,omitempty"`
    // Details - READ-ONLY; Internal error details.
    Details *[]ErrorDefinition `json:"details,omitempty"`
}

ErrorDefinition error definition.

type ErrorResponse Uses

type ErrorResponse struct {
    // Error - The error details.
    Error *ErrorDefinition `json:"error,omitempty"`
}

ErrorResponse error response.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the allows creation and deletion of Azure Shared Dashboards.

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.

func (OperationsClient) List Uses

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

List the Microsoft Portal operations API.

func (OperationsClient) ListComplete Uses

func (client OperationsClient) ListComplete(ctx context.Context) (result ResourceProviderOperationListIterator, err error)

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

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 ResourceProviderOperationList, 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 PatchableDashboard Uses

type PatchableDashboard struct {
    // DashboardProperties - The shared dashboard properties.
    *DashboardProperties `json:"properties,omitempty"`
    // Tags - Resource tags
    Tags map[string]*string `json:"tags"`
}

PatchableDashboard the shared dashboard resource definition.

func (PatchableDashboard) MarshalJSON Uses

func (pd PatchableDashboard) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PatchableDashboard.

func (*PatchableDashboard) UnmarshalJSON Uses

func (pd *PatchableDashboard) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PatchableDashboard struct.

type ResourceProviderOperation Uses

type ResourceProviderOperation struct {
    // Name - Operation name, in format of {provider}/{resource}/{operation}
    Name *string `json:"name,omitempty"`
    // IsDataAction - Indicates whether the operation applies to data-plane.
    IsDataAction *string `json:"isDataAction,omitempty"`
    // Display - Display metadata associated with the operation.
    Display *ResourceProviderOperationDisplay `json:"display,omitempty"`
}

ResourceProviderOperation supported operations of this resource provider.

type ResourceProviderOperationDisplay Uses

type ResourceProviderOperationDisplay struct {
    // Provider - Resource provider: Microsoft Custom Providers.
    Provider *string `json:"provider,omitempty"`
    // Resource - Resource on which the operation is performed.
    Resource *string `json:"resource,omitempty"`
    // Operation - Type of operation: get, read, delete, etc.
    Operation *string `json:"operation,omitempty"`
    // Description - Description of this operation.
    Description *string `json:"description,omitempty"`
}

ResourceProviderOperationDisplay display metadata associated with the operation.

type ResourceProviderOperationList Uses

type ResourceProviderOperationList struct {
    autorest.Response `json:"-"`
    // Value - List of operations supported by this resource provider.
    Value *[]ResourceProviderOperation `json:"value,omitempty"`
    // NextLink - The URL to use for getting the next set of results.
    NextLink *string `json:"nextLink,omitempty"`
}

ResourceProviderOperationList results of the request to list operations.

func (ResourceProviderOperationList) IsEmpty Uses

func (rpol ResourceProviderOperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceProviderOperationListIterator Uses

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

ResourceProviderOperationListIterator provides access to a complete listing of ResourceProviderOperation values.

func NewResourceProviderOperationListIterator Uses

func NewResourceProviderOperationListIterator(page ResourceProviderOperationListPage) ResourceProviderOperationListIterator

Creates a new instance of the ResourceProviderOperationListIterator type.

func (*ResourceProviderOperationListIterator) Next Uses

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

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

func (iter ResourceProviderOperationListIterator) NotDone() bool

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

func (ResourceProviderOperationListIterator) Response Uses

func (iter ResourceProviderOperationListIterator) Response() ResourceProviderOperationList

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

func (ResourceProviderOperationListIterator) Value Uses

func (iter ResourceProviderOperationListIterator) Value() ResourceProviderOperation

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

type ResourceProviderOperationListPage Uses

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

ResourceProviderOperationListPage contains a page of ResourceProviderOperation values.

func NewResourceProviderOperationListPage Uses

func NewResourceProviderOperationListPage(getNextPage func(context.Context, ResourceProviderOperationList) (ResourceProviderOperationList, error)) ResourceProviderOperationListPage

Creates a new instance of the ResourceProviderOperationListPage type.

func (*ResourceProviderOperationListPage) Next Uses

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

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

func (page ResourceProviderOperationListPage) NotDone() bool

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

func (ResourceProviderOperationListPage) Response Uses

func (page ResourceProviderOperationListPage) Response() ResourceProviderOperationList

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

func (ResourceProviderOperationListPage) Values Uses

func (page ResourceProviderOperationListPage) Values() []ResourceProviderOperation

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

Directories

PathSynopsis
portalapi

Package portal imports 9 packages (graph) and is imported by 4 packages. Updated 2019-08-01. Refresh now. Tools for package owners.