armlinks

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 16, 2021 License: MIT Imports: 12 Imported by: 6

README

PkgGoDev

The armlinks module provides operations for working with Azure Resource Links.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Resource Links module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armlinks

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Resource Links. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Resource Links modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armlinks.NewResourceLinksClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armlinks.NewResourceLinksClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Resource Links label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Operation 

type Operation struct {
	// The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
}

Operation - Microsoft.Resources operation

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation.
	Description *string `json:"description,omitempty"`

	// Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft.Resources
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed: Profile, endpoint, etc.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - The object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Microsoft.Resources operations.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsListOptions) *OperationsListPager

List - Lists all of the available Microsoft.Resources REST API operations. If the operation fails it returns a generic error.

type OperationsListOptions 

type OperationsListOptions struct {
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListPager 

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err 

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage 

func (p *OperationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsListPager) PageResponse 

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse 

type OperationsListResponse struct {
	OperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult 

type OperationsListResult struct {
	OperationListResult
}

OperationsListResult contains the result from method Operations.List. 

type ResourceLink struct {
	// Properties for resource link.
	Properties *ResourceLinkProperties `json:"properties,omitempty"`

	// READ-ONLY; The fully qualified ID of the resource link.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource link.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource link object.
	Type map[string]interface{} `json:"type,omitempty" azure:"ro"`
}

ResourceLink - The resource link.

type ResourceLinkFilter 

type ResourceLinkFilter struct {
	// REQUIRED; The ID of the target resource.
	TargetID *string `json:"targetId,omitempty"`
}

ResourceLinkFilter - Resource link filter.

type ResourceLinkProperties 

type ResourceLinkProperties struct {
	// REQUIRED; The fully qualified ID of the target resource in the link.
	TargetID *string `json:"targetId,omitempty"`

	// Notes about the resource link.
	Notes *string `json:"notes,omitempty"`

	// READ-ONLY; The fully qualified ID of the source resource in the link.
	SourceID *string `json:"sourceId,omitempty" azure:"ro"`
}

ResourceLinkProperties - The resource link properties.

type ResourceLinkResult 

type ResourceLinkResult struct {
	// REQUIRED; An array of resource links.
	Value []*ResourceLink `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ResourceLinkResult - List of resource links.

func (ResourceLinkResult) MarshalJSON 

func (r ResourceLinkResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceLinkResult.

type ResourceLinksClient 

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

ResourceLinksClient contains the methods for the ResourceLinks group. Don't use this type directly, use NewResourceLinksClient() instead.

func NewResourceLinksClient 

func NewResourceLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ResourceLinksClient

NewResourceLinksClient creates a new instance of ResourceLinksClient with the specified values.

func (*ResourceLinksClient) CreateOrUpdate 

func (client *ResourceLinksClient) CreateOrUpdate(ctx context.Context, linkID string, parameters ResourceLink, options *ResourceLinksCreateOrUpdateOptions) (ResourceLinksCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a resource link between the specified resources. If the operation fails it returns a generic error.

func (*ResourceLinksClient) Delete 

func (client *ResourceLinksClient) Delete(ctx context.Context, linkID string, options *ResourceLinksDeleteOptions) (ResourceLinksDeleteResponse, error)

Delete - Deletes a resource link with the specified ID. If the operation fails it returns a generic error.

func (*ResourceLinksClient) Get 

func (client *ResourceLinksClient) Get(ctx context.Context, linkID string, options *ResourceLinksGetOptions) (ResourceLinksGetResponse, error)

Get - Gets a resource link with the specified ID. If the operation fails it returns a generic error.

func (*ResourceLinksClient) ListAtSourceScope 

func (client *ResourceLinksClient) ListAtSourceScope(scope string, options *ResourceLinksListAtSourceScopeOptions) *ResourceLinksListAtSourceScopePager

ListAtSourceScope - Gets a list of resource links at and below the specified source scope. If the operation fails it returns a generic error.

func (*ResourceLinksClient) ListAtSubscription 

func (client *ResourceLinksClient) ListAtSubscription(options *ResourceLinksListAtSubscriptionOptions) *ResourceLinksListAtSubscriptionPager

ListAtSubscription - Gets all the linked resources for the subscription. If the operation fails it returns a generic error.

type ResourceLinksCreateOrUpdateOptions 

type ResourceLinksCreateOrUpdateOptions struct {
}

ResourceLinksCreateOrUpdateOptions contains the optional parameters for the ResourceLinks.CreateOrUpdate method.

type ResourceLinksCreateOrUpdateResponse 

type ResourceLinksCreateOrUpdateResponse struct {
	ResourceLinksCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceLinksCreateOrUpdateResponse contains the response from method ResourceLinks.CreateOrUpdate.

type ResourceLinksCreateOrUpdateResult 

type ResourceLinksCreateOrUpdateResult struct {
	ResourceLink
}

ResourceLinksCreateOrUpdateResult contains the result from method ResourceLinks.CreateOrUpdate.

type ResourceLinksDeleteOptions 

type ResourceLinksDeleteOptions struct {
}

ResourceLinksDeleteOptions contains the optional parameters for the ResourceLinks.Delete method.

type ResourceLinksDeleteResponse 

type ResourceLinksDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceLinksDeleteResponse contains the response from method ResourceLinks.Delete.

type ResourceLinksGetOptions 

type ResourceLinksGetOptions struct {
}

ResourceLinksGetOptions contains the optional parameters for the ResourceLinks.Get method.

type ResourceLinksGetResponse 

type ResourceLinksGetResponse struct {
	ResourceLinksGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceLinksGetResponse contains the response from method ResourceLinks.Get.

type ResourceLinksGetResult 

type ResourceLinksGetResult struct {
	ResourceLink
}

ResourceLinksGetResult contains the result from method ResourceLinks.Get.

type ResourceLinksListAtSourceScopeOptions 

type ResourceLinksListAtSourceScopeOptions struct {
	// The filter to apply when getting resource links. To get links only at the specified scope (not below the scope), use Filter.atScope().
	Filter *string
}

ResourceLinksListAtSourceScopeOptions contains the optional parameters for the ResourceLinks.ListAtSourceScope method.

type ResourceLinksListAtSourceScopePager 

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

ResourceLinksListAtSourceScopePager provides operations for iterating over paged responses.

func (*ResourceLinksListAtSourceScopePager) Err 

func (p *ResourceLinksListAtSourceScopePager) Err() error

Err returns the last error encountered while paging.

func (*ResourceLinksListAtSourceScopePager) NextPage 

func (p *ResourceLinksListAtSourceScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ResourceLinksListAtSourceScopePager) PageResponse 

func (p *ResourceLinksListAtSourceScopePager) PageResponse() ResourceLinksListAtSourceScopeResponse

PageResponse returns the current ResourceLinksListAtSourceScopeResponse page.

type ResourceLinksListAtSourceScopeResponse 

type ResourceLinksListAtSourceScopeResponse struct {
	ResourceLinksListAtSourceScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceLinksListAtSourceScopeResponse contains the response from method ResourceLinks.ListAtSourceScope.

type ResourceLinksListAtSourceScopeResult 

type ResourceLinksListAtSourceScopeResult struct {
	ResourceLinkResult
}

ResourceLinksListAtSourceScopeResult contains the result from method ResourceLinks.ListAtSourceScope.

type ResourceLinksListAtSubscriptionOptions 

type ResourceLinksListAtSubscriptionOptions struct {
	// The filter to apply on the list resource links operation. The supported filter for list resource links is targetId. For example, $filter=targetId eq
	// {value}
	Filter *string
}

ResourceLinksListAtSubscriptionOptions contains the optional parameters for the ResourceLinks.ListAtSubscription method.

type ResourceLinksListAtSubscriptionPager 

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

ResourceLinksListAtSubscriptionPager provides operations for iterating over paged responses.

func (*ResourceLinksListAtSubscriptionPager) Err 

func (p *ResourceLinksListAtSubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceLinksListAtSubscriptionPager) NextPage 

func (p *ResourceLinksListAtSubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ResourceLinksListAtSubscriptionPager) PageResponse 

func (p *ResourceLinksListAtSubscriptionPager) PageResponse() ResourceLinksListAtSubscriptionResponse

PageResponse returns the current ResourceLinksListAtSubscriptionResponse page.

type ResourceLinksListAtSubscriptionResponse 

type ResourceLinksListAtSubscriptionResponse struct {
	ResourceLinksListAtSubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceLinksListAtSubscriptionResponse contains the response from method ResourceLinks.ListAtSubscription.

type ResourceLinksListAtSubscriptionResult 

type ResourceLinksListAtSubscriptionResult struct {
	ResourceLinkResult
}

ResourceLinksListAtSubscriptionResult contains the result from method ResourceLinks.ListAtSubscription.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.