eligiblechildresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2020-10-01/eligiblechildresources Documentation

The eligiblechildresources SDK allows for interaction with the Azure Resource Manager Service authorization (API Version 2020-10-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2020-10-01/eligiblechildresources"

Client Initialization

client := eligiblechildresources.NewEligibleChildResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EligibleChildResourcesClient.Get

ctx := context.TODO()
id := eligiblechildresources.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

// alternatively `client.Get(ctx, id, eligiblechildresources.DefaultGetOperationOptions())` can be used to do batched pagination
items, err := client.GetComplete(ctx, id, eligiblechildresources.DefaultGetOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• type EligibleChildResource
• type EligibleChildResourceOperationPredicate
  • func (p EligibleChildResourceOperationPredicate) Matches(input EligibleChildResource) bool
• type EligibleChildResourcesClient
  • func NewEligibleChildResourcesClientWithBaseURI(api environments.Api) (*EligibleChildResourcesClient, error)
  • func (c EligibleChildResourcesClient) Get(ctx context.Context, id commonids.ScopeId, options GetOperationOptions) (result GetOperationResponse, err error)
  • func (c EligibleChildResourcesClient) GetComplete(ctx context.Context, id commonids.ScopeId, options GetOperationOptions) (GetCompleteResult, error)
  • func (c EligibleChildResourcesClient) GetCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options GetOperationOptions, ...) (result GetCompleteResult, err error)
• type GetCompleteResult
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
  • func (o GetOperationOptions) ToHeaders() *client.Headers
  • func (o GetOperationOptions) ToOData() *odata.Query
  • func (o GetOperationOptions) ToQuery() *client.QueryParams
• type GetOperationResponse

Types

type EligibleChildResource

type EligibleChildResource struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type EligibleChildResourceOperationPredicate

type EligibleChildResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (EligibleChildResourceOperationPredicate) Matches

func (p EligibleChildResourceOperationPredicate) Matches(input EligibleChildResource) bool

type EligibleChildResourcesClient

type EligibleChildResourcesClient struct {
	Client *resourcemanager.Client
}

func NewEligibleChildResourcesClientWithBaseURI

func NewEligibleChildResourcesClientWithBaseURI(api environments.Api) (*EligibleChildResourcesClient, error)

func (EligibleChildResourcesClient) Get

func (c EligibleChildResourcesClient) Get(ctx context.Context, id commonids.ScopeId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (EligibleChildResourcesClient) GetComplete

func (c EligibleChildResourcesClient) GetComplete(ctx context.Context, id commonids.ScopeId, options GetOperationOptions) (GetCompleteResult, error)

GetComplete retrieves all the results into a single object

func (EligibleChildResourcesClient) GetCompleteMatchingPredicate

func (c EligibleChildResourcesClient) GetCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options GetOperationOptions, predicate EligibleChildResourceOperationPredicate) (result GetCompleteResult, err error)

GetCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetCompleteResult

type GetCompleteResult struct {
	Items []EligibleChildResource
}

type GetOperationOptions

type GetOperationOptions struct {
	Filter *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EligibleChildResource
}