subscriptions

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2015-11-01/subscriptions Documentation

The subscriptions SDK allows for interaction with Azure Resource Manager resources (API Version 2015-11-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2015-11-01/subscriptions"

Client Initialization

client := subscriptions.NewSubscriptionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SubscriptionsClient.CheckZonePeers

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := subscriptions.CheckZonePeersRequest{
	// ...
}


read, err := client.CheckZonePeers(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SubscriptionsClient.Get

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SubscriptionsClient.List

ctx := context.TODO()


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

Example Usage: SubscriptionsClient.ListLocations

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.ListLocations(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• type AvailabilityZonePeers
• type CheckZonePeersOperationResponse
• type CheckZonePeersRequest
• type CheckZonePeersResult
• type GetOperationResponse
• type ListCompleteResult
• type ListCustomPager
  • func (p *ListCustomPager) NextPageLink() *odata.Link
• type ListLocationsOperationResponse
• type ListOperationResponse
• type Location
• type LocationListResult
• type Peers
• type Subscription
• type SubscriptionOperationPredicate
  • func (p SubscriptionOperationPredicate) Matches(input Subscription) bool
• type SubscriptionPolicies
• type SubscriptionsClient
  • func NewSubscriptionsClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionsClient, error)
  • func (c SubscriptionsClient) CheckZonePeers(ctx context.Context, id commonids.SubscriptionId, input CheckZonePeersRequest) (result CheckZonePeersOperationResponse, err error)
  • func (c SubscriptionsClient) Get(ctx context.Context, id commonids.SubscriptionId) (result GetOperationResponse, err error)
  • func (c SubscriptionsClient) List(ctx context.Context) (result ListOperationResponse, err error)
  • func (c SubscriptionsClient) ListComplete(ctx context.Context) (ListCompleteResult, error)
  • func (c SubscriptionsClient) ListCompleteMatchingPredicate(ctx context.Context, predicate SubscriptionOperationPredicate) (result ListCompleteResult, err error)
  • func (c SubscriptionsClient) ListLocations(ctx context.Context, id commonids.SubscriptionId) (result ListLocationsOperationResponse, err error)

Types

type AvailabilityZonePeers

type AvailabilityZonePeers struct {
	AvailabilityZone *string  `json:"availabilityZone,omitempty"`
	Peers            *[]Peers `json:"peers,omitempty"`
}

type CheckZonePeersOperationResponse

type CheckZonePeersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckZonePeersResult
}

type CheckZonePeersRequest

type CheckZonePeersRequest struct {
	Location        *string   `json:"location,omitempty"`
	SubscriptionIds *[]string `json:"subscriptionIds,omitempty"`
}

type CheckZonePeersResult

type CheckZonePeersResult struct {
	AvailabilityZonePeers *[]AvailabilityZonePeers `json:"availabilityZonePeers,omitempty"`
	Location              *string                  `json:"location,omitempty"`
	SubscriptionId        *string                  `json:"subscriptionId,omitempty"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Subscription
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Subscription
}

type ListCustomPager

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListCustomPager) NextPageLink

func (p *ListCustomPager) NextPageLink() *odata.Link

type ListLocationsOperationResponse

type ListLocationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LocationListResult
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Subscription
}

type Location

type Location struct {
	DisplayName    *string `json:"displayName,omitempty"`
	Id             *string `json:"id,omitempty"`
	Latitude       *string `json:"latitude,omitempty"`
	Longitude      *string `json:"longitude,omitempty"`
	Name           *string `json:"name,omitempty"`
	SubscriptionId *string `json:"subscriptionId,omitempty"`
}

type LocationListResult

type LocationListResult struct {
	Value *[]Location `json:"value,omitempty"`
}

type Peers

type Peers struct {
	AvailabilityZone *string `json:"availabilityZone,omitempty"`
	SubscriptionId   *string `json:"subscriptionId,omitempty"`
}

type Subscription

type Subscription struct {
	DisplayName          *string               `json:"displayName,omitempty"`
	Id                   *string               `json:"id,omitempty"`
	State                *string               `json:"state,omitempty"`
	SubscriptionId       *string               `json:"subscriptionId,omitempty"`
	SubscriptionPolicies *SubscriptionPolicies `json:"subscriptionPolicies,omitempty"`
}

type SubscriptionOperationPredicate

type SubscriptionOperationPredicate struct {
	DisplayName    *string
	Id             *string
	State          *string
	SubscriptionId *string
}

func (SubscriptionOperationPredicate) Matches

func (p SubscriptionOperationPredicate) Matches(input Subscription) bool

type SubscriptionPolicies

type SubscriptionPolicies struct {
	LocationPlacementId *string `json:"locationPlacementId,omitempty"`
	QuotaId             *string `json:"quotaId,omitempty"`
}

type SubscriptionsClient

type SubscriptionsClient struct {
	Client *resourcemanager.Client
}

func NewSubscriptionsClientWithBaseURI

func NewSubscriptionsClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionsClient, error)

func (SubscriptionsClient) CheckZonePeers

func (c SubscriptionsClient) CheckZonePeers(ctx context.Context, id commonids.SubscriptionId, input CheckZonePeersRequest) (result CheckZonePeersOperationResponse, err error)

CheckZonePeers ...

func (SubscriptionsClient) Get

func (c SubscriptionsClient) Get(ctx context.Context, id commonids.SubscriptionId) (result GetOperationResponse, err error)

Get ...

func (SubscriptionsClient) List

func (c SubscriptionsClient) List(ctx context.Context) (result ListOperationResponse, err error)

List ...

func (SubscriptionsClient) ListComplete

func (c SubscriptionsClient) ListComplete(ctx context.Context) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SubscriptionsClient) ListCompleteMatchingPredicate

func (c SubscriptionsClient) ListCompleteMatchingPredicate(ctx context.Context, predicate SubscriptionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SubscriptionsClient) ListLocations

func (c SubscriptionsClient) ListLocations(ctx context.Context, id commonids.SubscriptionId) (result ListLocationsOperationResponse, err error)

ListLocations ...