Documentation ¶
Overview ¶
Package links implements the Azure ARM Links service API version 2016-09-01.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type Filter
- type ManagementClient
- type ResourceLink
- type ResourceLinkFilter
- type ResourceLinkProperties
- type ResourceLinkResult
- type ResourceLinksClient
- func (client ResourceLinksClient) CreateOrUpdate(linkID string, parameters ResourceLink) (result ResourceLink, err error)
- func (client ResourceLinksClient) CreateOrUpdatePreparer(linkID string, parameters ResourceLink) (*http.Request, error)
- func (client ResourceLinksClient) CreateOrUpdateResponder(resp *http.Response) (result ResourceLink, err error)
- func (client ResourceLinksClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client ResourceLinksClient) Delete(linkID string) (result autorest.Response, err error)
- func (client ResourceLinksClient) DeletePreparer(linkID string) (*http.Request, error)
- func (client ResourceLinksClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ResourceLinksClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client ResourceLinksClient) Get(linkID string) (result ResourceLink, err error)
- func (client ResourceLinksClient) GetPreparer(linkID string) (*http.Request, error)
- func (client ResourceLinksClient) GetResponder(resp *http.Response) (result ResourceLink, err error)
- func (client ResourceLinksClient) GetSender(req *http.Request) (*http.Response, error)
- func (client ResourceLinksClient) ListAtSourceScope(scope string, filter Filter) (result ResourceLinkResult, err error)
- func (client ResourceLinksClient) ListAtSourceScopeNextResults(lastResults ResourceLinkResult) (result ResourceLinkResult, err error)
- func (client ResourceLinksClient) ListAtSourceScopePreparer(scope string, filter Filter) (*http.Request, error)
- func (client ResourceLinksClient) ListAtSourceScopeResponder(resp *http.Response) (result ResourceLinkResult, err error)
- func (client ResourceLinksClient) ListAtSourceScopeSender(req *http.Request) (*http.Response, error)
- func (client ResourceLinksClient) ListAtSubscription(filter string) (result ResourceLinkResult, err error)
- func (client ResourceLinksClient) ListAtSubscriptionNextResults(lastResults ResourceLinkResult) (result ResourceLinkResult, err error)
- func (client ResourceLinksClient) ListAtSubscriptionPreparer(filter string) (*http.Request, error)
- func (client ResourceLinksClient) ListAtSubscriptionResponder(resp *http.Response) (result ResourceLinkResult, err error)
- func (client ResourceLinksClient) ListAtSubscriptionSender(req *http.Request) (*http.Response, error)
Constants ¶
const ( // APIVersion is the version of the Links APIVersion = "2016-09-01" // DefaultBaseURI is the default URI used for the service Links 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 Filter ¶
type Filter string
Filter enumerates the values for filter.
const ( // AtScope specifies the at scope state for filter. AtScope Filter = "atScope()" )
type ManagementClient ¶
type ManagementClient struct { autorest.Client BaseURI string APIVersion string SubscriptionID string }
ManagementClient is the base client for Links.
func New ¶
func New(subscriptionID string) ManagementClient
New creates an instance of the ManagementClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
NewWithBaseURI creates an instance of the ManagementClient client.
type ResourceLink ¶
type ResourceLink struct { autorest.Response `json:"-"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *ResourceLinkProperties `json:"properties,omitempty"` }
ResourceLink is the resource link.
type ResourceLinkFilter ¶
type ResourceLinkFilter struct {
TargetID *string `json:"targetId,omitempty"`
}
ResourceLinkFilter is resource link filter.
type ResourceLinkProperties ¶
type ResourceLinkProperties struct { SourceID *string `json:"sourceId,omitempty"` TargetID *string `json:"targetId,omitempty"` Notes *string `json:"notes,omitempty"` }
ResourceLinkProperties is the resource link properties.
type ResourceLinkResult ¶
type ResourceLinkResult struct { autorest.Response `json:"-"` Value *[]ResourceLink `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
ResourceLinkResult is list of resource links.
func (ResourceLinkResult) ResourceLinkResultPreparer ¶
func (client ResourceLinkResult) ResourceLinkResultPreparer() (*http.Request, error)
ResourceLinkResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type ResourceLinksClient ¶
type ResourceLinksClient struct {
ManagementClient
}
ResourceLinksClient is the client for the ResourceLinks methods of the Links service.
func NewResourceLinksClient ¶
func NewResourceLinksClient(subscriptionID string) ResourceLinksClient
NewResourceLinksClient creates an instance of the ResourceLinksClient client.
func NewResourceLinksClientWithBaseURI ¶
func NewResourceLinksClientWithBaseURI(baseURI string, subscriptionID string) ResourceLinksClient
NewResourceLinksClientWithBaseURI creates an instance of the ResourceLinksClient client.
func (ResourceLinksClient) CreateOrUpdate ¶
func (client ResourceLinksClient) CreateOrUpdate(linkID string, parameters ResourceLink) (result ResourceLink, err error)
CreateOrUpdate create a resource link.
linkID is the fully qualified Id of the resource link. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink parameters is create or update resource link parameters.
func (ResourceLinksClient) CreateOrUpdatePreparer ¶
func (client ResourceLinksClient) CreateOrUpdatePreparer(linkID string, parameters ResourceLink) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (ResourceLinksClient) CreateOrUpdateResponder ¶
func (client ResourceLinksClient) CreateOrUpdateResponder(resp *http.Response) (result ResourceLink, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (ResourceLinksClient) CreateOrUpdateSender ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (ResourceLinksClient) Delete ¶
func (client ResourceLinksClient) Delete(linkID string) (result autorest.Response, err error)
Delete deletes a resource link.
linkID is the fully qualified Id of the resource link. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink
func (ResourceLinksClient) DeletePreparer ¶
func (client ResourceLinksClient) DeletePreparer(linkID string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (ResourceLinksClient) DeleteResponder ¶
func (client ResourceLinksClient) 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 (ResourceLinksClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (ResourceLinksClient) Get ¶
func (client ResourceLinksClient) Get(linkID string) (result ResourceLink, err error)
Get gets a resource link.
linkID is the fully qualified Id of the resource link. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink
func (ResourceLinksClient) GetPreparer ¶
func (client ResourceLinksClient) GetPreparer(linkID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (ResourceLinksClient) GetResponder ¶
func (client ResourceLinksClient) GetResponder(resp *http.Response) (result ResourceLink, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (ResourceLinksClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (ResourceLinksClient) ListAtSourceScope ¶
func (client ResourceLinksClient) ListAtSourceScope(scope string, filter Filter) (result ResourceLinkResult, err error)
ListAtSourceScope gets a list of resource links at and below the specified source scope. For example, to list resource links at and under a resource group, set the scope to /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup.
scope is the fully qualified Id of the source resource scope. For example, to list resource links at and under a resource group, set the scope to /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup. filter is the filter to apply on the list resource links operation. To list links only at the specified scope (not below the scope), use Filter.atScope(). Possible values include: 'atScope()'
func (ResourceLinksClient) ListAtSourceScopeNextResults ¶
func (client ResourceLinksClient) ListAtSourceScopeNextResults(lastResults ResourceLinkResult) (result ResourceLinkResult, err error)
ListAtSourceScopeNextResults retrieves the next set of results, if any.
func (ResourceLinksClient) ListAtSourceScopePreparer ¶
func (client ResourceLinksClient) ListAtSourceScopePreparer(scope string, filter Filter) (*http.Request, error)
ListAtSourceScopePreparer prepares the ListAtSourceScope request.
func (ResourceLinksClient) ListAtSourceScopeResponder ¶
func (client ResourceLinksClient) ListAtSourceScopeResponder(resp *http.Response) (result ResourceLinkResult, err error)
ListAtSourceScopeResponder handles the response to the ListAtSourceScope request. The method always closes the http.Response Body.
func (ResourceLinksClient) ListAtSourceScopeSender ¶
func (client ResourceLinksClient) ListAtSourceScopeSender(req *http.Request) (*http.Response, error)
ListAtSourceScopeSender sends the ListAtSourceScope request. The method will close the http.Response Body if it receives an error.
func (ResourceLinksClient) ListAtSubscription ¶
func (client ResourceLinksClient) ListAtSubscription(filter string) (result ResourceLinkResult, err error)
ListAtSubscription gets a list of resource links under the subscription.
filter is the filter to apply on the list resource links operation. The supported filter for list resource links is targetId.
func (ResourceLinksClient) ListAtSubscriptionNextResults ¶
func (client ResourceLinksClient) ListAtSubscriptionNextResults(lastResults ResourceLinkResult) (result ResourceLinkResult, err error)
ListAtSubscriptionNextResults retrieves the next set of results, if any.
func (ResourceLinksClient) ListAtSubscriptionPreparer ¶
func (client ResourceLinksClient) ListAtSubscriptionPreparer(filter string) (*http.Request, error)
ListAtSubscriptionPreparer prepares the ListAtSubscription request.
func (ResourceLinksClient) ListAtSubscriptionResponder ¶
func (client ResourceLinksClient) ListAtSubscriptionResponder(resp *http.Response) (result ResourceLinkResult, err error)
ListAtSubscriptionResponder handles the response to the ListAtSubscription request. The method always closes the http.Response Body.
func (ResourceLinksClient) ListAtSubscriptionSender ¶
func (client ResourceLinksClient) ListAtSubscriptionSender(req *http.Request) (*http.Response, error)
ListAtSubscriptionSender sends the ListAtSubscription request. The method will close the http.Response Body if it receives an error.