Documentation ¶
Overview ¶
Package portal implements the Azure ARM Portal service API version 2019-01-01-preview.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AzureEntityResource
- type BaseClient
- type Configuration
- type ConfigurationList
- type ConfigurationProperties
- type Dashboard
- type DashboardLens
- type DashboardListResult
- type DashboardListResultIterator
- func (iter *DashboardListResultIterator) Next() error
- func (iter *DashboardListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter DashboardListResultIterator) NotDone() bool
- func (iter DashboardListResultIterator) Response() DashboardListResult
- func (iter DashboardListResultIterator) Value() Dashboard
- type DashboardListResultPage
- func (page *DashboardListResultPage) Next() error
- func (page *DashboardListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page DashboardListResultPage) NotDone() bool
- func (page DashboardListResultPage) Response() DashboardListResult
- func (page DashboardListResultPage) Values() []Dashboard
- type DashboardParts
- type DashboardPartsPosition
- type DashboardProperties
- type DashboardsClient
- func (client DashboardsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, dashboardName string, ...) (result Dashboard, err error)
- func (client DashboardsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, dashboardName string, ...) (*http.Request, error)
- func (client DashboardsClient) CreateOrUpdateResponder(resp *http.Response) (result Dashboard, err error)
- func (client DashboardsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client DashboardsClient) Delete(ctx context.Context, resourceGroupName string, dashboardName string) (result autorest.Response, err error)
- func (client DashboardsClient) DeletePreparer(ctx context.Context, resourceGroupName string, dashboardName string) (*http.Request, error)
- func (client DashboardsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DashboardsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client DashboardsClient) Get(ctx context.Context, resourceGroupName string, dashboardName string) (result Dashboard, err error)
- func (client DashboardsClient) GetPreparer(ctx context.Context, resourceGroupName string, dashboardName string) (*http.Request, error)
- func (client DashboardsClient) GetResponder(resp *http.Response) (result Dashboard, err error)
- func (client DashboardsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client DashboardsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DashboardListResultPage, err error)
- func (client DashboardsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DashboardListResultIterator, err error)
- func (client DashboardsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client DashboardsClient) ListByResourceGroupResponder(resp *http.Response) (result DashboardListResult, err error)
- func (client DashboardsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client DashboardsClient) ListBySubscription(ctx context.Context) (result DashboardListResultPage, err error)
- func (client DashboardsClient) ListBySubscriptionComplete(ctx context.Context) (result DashboardListResultIterator, err error)
- func (client DashboardsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client DashboardsClient) ListBySubscriptionResponder(resp *http.Response) (result DashboardListResult, err error)
- func (client DashboardsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client DashboardsClient) Update(ctx context.Context, resourceGroupName string, dashboardName string, ...) (result Dashboard, err error)
- func (client DashboardsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, dashboardName string, ...) (*http.Request, error)
- func (client DashboardsClient) UpdateResponder(resp *http.Response) (result Dashboard, err error)
- func (client DashboardsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type ErrorDefinition
- type ErrorResponse
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result ResourceProviderOperationListPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result ResourceProviderOperationListIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result ResourceProviderOperationList, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type PatchableDashboard
- type ProxyResource
- type Resource
- type ResourceProviderOperation
- type ResourceProviderOperationDisplay
- type ResourceProviderOperationList
- type ResourceProviderOperationListIterator
- func (iter *ResourceProviderOperationListIterator) Next() error
- func (iter *ResourceProviderOperationListIterator) NextWithContext(ctx context.Context) (err error)
- func (iter ResourceProviderOperationListIterator) NotDone() bool
- func (iter ResourceProviderOperationListIterator) Response() ResourceProviderOperationList
- func (iter ResourceProviderOperationListIterator) Value() ResourceProviderOperation
- type ResourceProviderOperationListPage
- func (page *ResourceProviderOperationListPage) Next() error
- func (page *ResourceProviderOperationListPage) NextWithContext(ctx context.Context) (err error)
- func (page ResourceProviderOperationListPage) NotDone() bool
- func (page ResourceProviderOperationListPage) Response() ResourceProviderOperationList
- func (page ResourceProviderOperationListPage) Values() []ResourceProviderOperation
- type TenantConfigurationsClient
- func (client TenantConfigurationsClient) Create(ctx context.Context, tenantConfiguration Configuration) (result Configuration, err error)
- func (client TenantConfigurationsClient) CreatePreparer(ctx context.Context, tenantConfiguration Configuration) (*http.Request, error)
- func (client TenantConfigurationsClient) CreateResponder(resp *http.Response) (result Configuration, err error)
- func (client TenantConfigurationsClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client TenantConfigurationsClient) Delete(ctx context.Context) (result autorest.Response, err error)
- func (client TenantConfigurationsClient) DeletePreparer(ctx context.Context) (*http.Request, error)
- func (client TenantConfigurationsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client TenantConfigurationsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client TenantConfigurationsClient) Get(ctx context.Context) (result Configuration, err error)
- func (client TenantConfigurationsClient) GetPreparer(ctx context.Context) (*http.Request, error)
- func (client TenantConfigurationsClient) GetResponder(resp *http.Response) (result Configuration, err error)
- func (client TenantConfigurationsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client TenantConfigurationsClient) List(ctx context.Context) (result ConfigurationList, err error)
- func (client TenantConfigurationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client TenantConfigurationsClient) ListResponder(resp *http.Response) (result ConfigurationList, err error)
- func (client TenantConfigurationsClient) ListSender(req *http.Request) (*http.Response, error)
- type TrackedResource
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Portal
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 AzureEntityResource ¶
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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.
type BaseClient ¶
BaseClient is the base client for Portal.
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type Configuration ¶
type Configuration struct { autorest.Response `json:"-"` // ConfigurationProperties - Tenant configuration properties. *ConfigurationProperties `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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
Configuration tenant configuration.
func (Configuration) MarshalJSON ¶
func (c Configuration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Configuration.
func (*Configuration) UnmarshalJSON ¶
func (c *Configuration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Configuration struct.
type ConfigurationList ¶
type ConfigurationList struct { autorest.Response `json:"-"` // Value - The array of tenant configurations. Value *[]Configuration `json:"value,omitempty"` // NextLink - The URL to use for getting the next set of results. NextLink *string `json:"nextLink,omitempty"` }
ConfigurationList list of tenant configurations.
type ConfigurationProperties ¶
type ConfigurationProperties struct { // EnforcePrivateMarkdownStorage - When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. EnforcePrivateMarkdownStorage *bool `json:"enforcePrivateMarkdownStorage,omitempty"` }
ConfigurationProperties tenant configuration properties.
type Dashboard ¶
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 ¶
MarshalJSON is the custom marshaler for Dashboard.
func (*Dashboard) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Dashboard struct.
type DashboardLens ¶
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 ¶
func (dl DashboardLens) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DashboardLens.
type DashboardListResult ¶
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 ¶
func (dlr DashboardListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DashboardListResultIterator ¶
type DashboardListResultIterator struct {
// contains filtered or unexported fields
}
DashboardListResultIterator provides access to a complete listing of Dashboard values.
func NewDashboardListResultIterator ¶
func NewDashboardListResultIterator(page DashboardListResultPage) DashboardListResultIterator
Creates a new instance of the DashboardListResultIterator type.
func (*DashboardListResultIterator) Next ¶
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 ¶
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 ¶
func (iter DashboardListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (DashboardListResultIterator) Response ¶
func (iter DashboardListResultIterator) Response() DashboardListResult
Response returns the raw server response from the last page request.
func (DashboardListResultIterator) Value ¶
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 ¶
type DashboardListResultPage struct {
// contains filtered or unexported fields
}
DashboardListResultPage contains a page of Dashboard values.
func NewDashboardListResultPage ¶
func NewDashboardListResultPage(cur DashboardListResult, getNextPage func(context.Context, DashboardListResult) (DashboardListResult, error)) DashboardListResultPage
Creates a new instance of the DashboardListResultPage type.
func (*DashboardListResultPage) Next ¶
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 ¶
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 ¶
func (page DashboardListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (DashboardListResultPage) Response ¶
func (page DashboardListResultPage) Response() DashboardListResult
Response returns the raw server response from the last page request.
func (DashboardListResultPage) Values ¶
func (page DashboardListResultPage) Values() []Dashboard
Values returns the slice of values for the current page or nil if there are no values.
type DashboardParts ¶
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 ¶
func (dp DashboardParts) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DashboardParts.
type DashboardPartsPosition ¶
type DashboardPartsPosition struct { // X - The dashboard's part x coordinate. X *int32 `json:"x,omitempty"` // Y - The dashboard's part y coordinate. Y *int32 `json:"y,omitempty"` // RowSpan - The dashboard's part row span. RowSpan *int32 `json:"rowSpan,omitempty"` // ColSpan - The dashboard's part column span. ColSpan *int32 `json:"colSpan,omitempty"` // Metadata - The dashboard part's metadata. Metadata map[string]interface{} `json:"metadata"` }
DashboardPartsPosition the dashboard's part position.
func (DashboardPartsPosition) MarshalJSON ¶
func (dp DashboardPartsPosition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DashboardPartsPosition.
type DashboardProperties ¶
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 ¶
func (dp DashboardProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DashboardProperties.
type DashboardsClient ¶
type DashboardsClient struct {
BaseClient
}
DashboardsClient is the client for the Dashboards methods of the Portal service.
func NewDashboardsClient ¶
func NewDashboardsClient(subscriptionID string) DashboardsClient
NewDashboardsClient creates an instance of the DashboardsClient client.
func NewDashboardsClientWithBaseURI ¶
func NewDashboardsClientWithBaseURI(baseURI string, subscriptionID string) DashboardsClient
NewDashboardsClientWithBaseURI creates an instance of the DashboardsClient 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 (DashboardsClient) CreateOrUpdate ¶
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 ¶
func (client DashboardsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, dashboardName string, dashboard Dashboard) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (DashboardsClient) CreateOrUpdateResponder ¶
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 ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (DashboardsClient) Delete ¶
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 ¶
func (client DashboardsClient) DeletePreparer(ctx context.Context, resourceGroupName string, dashboardName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (DashboardsClient) DeleteResponder ¶
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 ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (DashboardsClient) Get ¶
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 ¶
func (client DashboardsClient) GetPreparer(ctx context.Context, resourceGroupName string, dashboardName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (DashboardsClient) GetResponder ¶
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 ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (DashboardsClient) ListByResourceGroup ¶
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 ¶
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 ¶
func (client DashboardsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (DashboardsClient) ListByResourceGroupResponder ¶
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 ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (DashboardsClient) ListBySubscription ¶
func (client DashboardsClient) ListBySubscription(ctx context.Context) (result DashboardListResultPage, err error)
ListBySubscription gets all the dashboards within a subscription.
func (DashboardsClient) ListBySubscriptionComplete ¶
func (client DashboardsClient) ListBySubscriptionComplete(ctx context.Context) (result DashboardListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (DashboardsClient) ListBySubscriptionPreparer ¶
func (client DashboardsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (DashboardsClient) ListBySubscriptionResponder ¶
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 ¶
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (DashboardsClient) Update ¶
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 ¶
func (client DashboardsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, dashboardName string, dashboard PatchableDashboard) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (DashboardsClient) UpdateResponder ¶
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 ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ErrorDefinition ¶
type ErrorDefinition struct { // Code - READ-ONLY; Service specific error code which serves as the substatus for the HTTP error code. Code *int32 `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 ¶
type ErrorResponse struct { // Error - The error details. Error *ErrorDefinition `json:"error,omitempty"` }
ErrorResponse error response.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the client for the Operations methods of the Portal service.
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 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 ¶
func (client OperationsClient) List(ctx context.Context) (result ResourceProviderOperationListPage, err error)
List the Microsoft Portal operations API.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result ResourceProviderOperationListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PatchableDashboard ¶
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 ¶
func (pd PatchableDashboard) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchableDashboard.
func (*PatchableDashboard) UnmarshalJSON ¶
func (pd *PatchableDashboard) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PatchableDashboard struct.
type ProxyResource ¶
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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
ProxyResource the resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags
type Resource ¶
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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
Resource common fields that are returned in the response for all Azure Resource Manager resources
type ResourceProviderOperation ¶
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 ¶
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 ¶
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 ¶
func (rpol ResourceProviderOperationList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ResourceProviderOperationListIterator ¶
type ResourceProviderOperationListIterator struct {
// contains filtered or unexported fields
}
ResourceProviderOperationListIterator provides access to a complete listing of ResourceProviderOperation values.
func NewResourceProviderOperationListIterator ¶
func NewResourceProviderOperationListIterator(page ResourceProviderOperationListPage) ResourceProviderOperationListIterator
Creates a new instance of the ResourceProviderOperationListIterator type.
func (*ResourceProviderOperationListIterator) Next ¶
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 ¶
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 ¶
func (iter ResourceProviderOperationListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ResourceProviderOperationListIterator) Response ¶
func (iter ResourceProviderOperationListIterator) Response() ResourceProviderOperationList
Response returns the raw server response from the last page request.
func (ResourceProviderOperationListIterator) Value ¶
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 ¶
type ResourceProviderOperationListPage struct {
// contains filtered or unexported fields
}
ResourceProviderOperationListPage contains a page of ResourceProviderOperation values.
func NewResourceProviderOperationListPage ¶
func NewResourceProviderOperationListPage(cur ResourceProviderOperationList, getNextPage func(context.Context, ResourceProviderOperationList) (ResourceProviderOperationList, error)) ResourceProviderOperationListPage
Creates a new instance of the ResourceProviderOperationListPage type.
func (*ResourceProviderOperationListPage) Next ¶
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 ¶
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 ¶
func (page ResourceProviderOperationListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ResourceProviderOperationListPage) Response ¶
func (page ResourceProviderOperationListPage) Response() ResourceProviderOperationList
Response returns the raw server response from the last page request.
func (ResourceProviderOperationListPage) Values ¶
func (page ResourceProviderOperationListPage) Values() []ResourceProviderOperation
Values returns the slice of values for the current page or nil if there are no values.
type TenantConfigurationsClient ¶
type TenantConfigurationsClient struct {
BaseClient
}
TenantConfigurationsClient is the client for the TenantConfigurations methods of the Portal service.
func NewTenantConfigurationsClient ¶
func NewTenantConfigurationsClient(subscriptionID string) TenantConfigurationsClient
NewTenantConfigurationsClient creates an instance of the TenantConfigurationsClient client.
func NewTenantConfigurationsClientWithBaseURI ¶
func NewTenantConfigurationsClientWithBaseURI(baseURI string, subscriptionID string) TenantConfigurationsClient
NewTenantConfigurationsClientWithBaseURI creates an instance of the TenantConfigurationsClient 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 (TenantConfigurationsClient) Create ¶
func (client TenantConfigurationsClient) Create(ctx context.Context, tenantConfiguration Configuration) (result Configuration, err error)
Create create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. Parameters: tenantConfiguration - the parameters required to create or update tenant configuration.
func (TenantConfigurationsClient) CreatePreparer ¶
func (client TenantConfigurationsClient) CreatePreparer(ctx context.Context, tenantConfiguration Configuration) (*http.Request, error)
CreatePreparer prepares the Create request.
func (TenantConfigurationsClient) CreateResponder ¶
func (client TenantConfigurationsClient) CreateResponder(resp *http.Response) (result Configuration, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (TenantConfigurationsClient) CreateSender ¶
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (TenantConfigurationsClient) Delete ¶
func (client TenantConfigurationsClient) Delete(ctx context.Context) (result autorest.Response, err error)
Delete delete the tenant configuration. User has to be a Tenant Admin for this operation.
func (TenantConfigurationsClient) DeletePreparer ¶
DeletePreparer prepares the Delete request.
func (TenantConfigurationsClient) DeleteResponder ¶
func (client TenantConfigurationsClient) 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 (TenantConfigurationsClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (TenantConfigurationsClient) Get ¶
func (client TenantConfigurationsClient) Get(ctx context.Context) (result Configuration, err error)
Get gets the tenant configuration.
func (TenantConfigurationsClient) GetPreparer ¶
GetPreparer prepares the Get request.
func (TenantConfigurationsClient) GetResponder ¶
func (client TenantConfigurationsClient) GetResponder(resp *http.Response) (result Configuration, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (TenantConfigurationsClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (TenantConfigurationsClient) List ¶
func (client TenantConfigurationsClient) List(ctx context.Context) (result ConfigurationList, err error)
List gets list of the tenant configurations.
func (TenantConfigurationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (TenantConfigurationsClient) ListResponder ¶
func (client TenantConfigurationsClient) ListResponder(resp *http.Response) (result ConfigurationList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (TenantConfigurationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type TrackedResource ¶
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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource
func (TrackedResource) MarshalJSON ¶
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.