resources

package
v0.20240628.1082451 Latest Latest
Warning

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

 Go to latest Published: Jun 28, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2023-07-01/resources Documentation

The resources SDK allows for interaction with the Azure Resource Manager Service resources (API Version 2023-07-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/2023-07-01/resources"

Client Initialization

client := resources.NewResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourcesClient.CheckExistence

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

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

Example Usage: ResourcesClient.CheckExistenceById

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

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

Example Usage: ResourcesClient.CreateOrUpdate

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

payload := resources.GenericResource{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ResourcesClient.CreateOrUpdateById

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

payload := resources.GenericResource{
	// ...
}


if err := client.CreateOrUpdateByIdThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ResourcesClient.Delete

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

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ResourcesClient.DeleteById

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

if err := client.DeleteByIdThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ResourcesClient.Get

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

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: ResourcesClient.GetById

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

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

Example Usage: ResourcesClient.List

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

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

Example Usage: ResourcesClient.MoveResources

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

payload := resources.ResourcesMoveInfo{
	// ...
}


if err := client.MoveResourcesThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ResourcesClient.Update

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

payload := resources.GenericResource{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ResourcesClient.UpdateById

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

payload := resources.GenericResource{
	// ...
}


if err := client.UpdateByIdThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ResourcesClient.ValidateMoveResources

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

payload := resources.ResourcesMoveInfo{
	// ...
}


if err := client.ValidateMoveResourcesThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckExistenceByIdOperationResponse 

type CheckExistenceByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CheckExistenceOperationResponse 

type CheckExistenceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CreateOrUpdateByIdOperationResponse 

type CreateOrUpdateByIdOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GenericResource
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GenericResource
}

type DeleteByIdOperationResponse 

type DeleteByIdOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GenericResource 

type GenericResource struct {
	ExtendedLocation *edgezones.Model                   `json:"extendedLocation,omitempty"`
	Id               *string                            `json:"id,omitempty"`
	Identity         *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Kind             *string                            `json:"kind,omitempty"`
	Location         *string                            `json:"location,omitempty"`
	ManagedBy        *string                            `json:"managedBy,omitempty"`
	Name             *string                            `json:"name,omitempty"`
	Plan             *Plan                              `json:"plan,omitempty"`
	Properties       *interface{}                       `json:"properties,omitempty"`
	Sku              *Sku                               `json:"sku,omitempty"`
	Tags             *map[string]string                 `json:"tags,omitempty"`
	Type             *string                            `json:"type,omitempty"`
}

type GenericResourceExpanded 

type GenericResourceExpanded struct {
	ChangedTime       *string                            `json:"changedTime,omitempty"`
	CreatedTime       *string                            `json:"createdTime,omitempty"`
	ExtendedLocation  *edgezones.Model                   `json:"extendedLocation,omitempty"`
	Id                *string                            `json:"id,omitempty"`
	Identity          *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Kind              *string                            `json:"kind,omitempty"`
	Location          *string                            `json:"location,omitempty"`
	ManagedBy         *string                            `json:"managedBy,omitempty"`
	Name              *string                            `json:"name,omitempty"`
	Plan              *Plan                              `json:"plan,omitempty"`
	Properties        *interface{}                       `json:"properties,omitempty"`
	ProvisioningState *string                            `json:"provisioningState,omitempty"`
	Sku               *Sku                               `json:"sku,omitempty"`
	Tags              *map[string]string                 `json:"tags,omitempty"`
	Type              *string                            `json:"type,omitempty"`
}

func (*GenericResourceExpanded) GetChangedTimeAsTime 

func (o *GenericResourceExpanded) GetChangedTimeAsTime() (*time.Time, error)

func (*GenericResourceExpanded) GetCreatedTimeAsTime 

func (o *GenericResourceExpanded) GetCreatedTimeAsTime() (*time.Time, error)

func (*GenericResourceExpanded) SetChangedTimeAsTime 

func (o *GenericResourceExpanded) SetChangedTimeAsTime(input time.Time)

func (*GenericResourceExpanded) SetCreatedTimeAsTime 

func (o *GenericResourceExpanded) SetCreatedTimeAsTime(input time.Time)

type GenericResourceExpandedOperationPredicate 

type GenericResourceExpandedOperationPredicate struct {
	ChangedTime       *string
	CreatedTime       *string
	Id                *string
	Kind              *string
	Location          *string
	ManagedBy         *string
	Name              *string
	Properties        *interface{}
	ProvisioningState *string
	Type              *string
}

func (GenericResourceExpandedOperationPredicate) Matches 

func (p GenericResourceExpandedOperationPredicate) Matches(input GenericResourceExpanded) bool

type GetByIdOperationResponse 

type GetByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GenericResource
}

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Expand *string
	Filter *string
	Top    *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

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

type MoveResourcesOperationResponse 

type MoveResourcesOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type Plan 

type Plan struct {
	Name          *string `json:"name,omitempty"`
	Product       *string `json:"product,omitempty"`
	PromotionCode *string `json:"promotionCode,omitempty"`
	Publisher     *string `json:"publisher,omitempty"`
	Version       *string `json:"version,omitempty"`
}

type ResourcesClient 

type ResourcesClient struct {
	Client *resourcemanager.Client
}

func NewResourcesClientWithBaseURI 

func NewResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourcesClient, error)

func (ResourcesClient) CheckExistence 

func (c ResourcesClient) CheckExistence(ctx context.Context, id commonids.ScopeId) (result CheckExistenceOperationResponse, err error)

CheckExistence ...

func (ResourcesClient) CheckExistenceById 

func (c ResourcesClient) CheckExistenceById(ctx context.Context, id commonids.ScopeId) (result CheckExistenceByIdOperationResponse, err error)

CheckExistenceById ...

func (ResourcesClient) CreateOrUpdate 

func (c ResourcesClient) CreateOrUpdate(ctx context.Context, id commonids.ScopeId, input GenericResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ResourcesClient) CreateOrUpdateById 

func (c ResourcesClient) CreateOrUpdateById(ctx context.Context, id commonids.ScopeId, input GenericResource) (result CreateOrUpdateByIdOperationResponse, err error)

CreateOrUpdateById ...

func (ResourcesClient) CreateOrUpdateByIdThenPoll 

func (c ResourcesClient) CreateOrUpdateByIdThenPoll(ctx context.Context, id commonids.ScopeId, input GenericResource) error

CreateOrUpdateByIdThenPoll performs CreateOrUpdateById then polls until it's completed

func (ResourcesClient) CreateOrUpdateThenPoll 

func (c ResourcesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.ScopeId, input GenericResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ResourcesClient) Delete 

func (c ResourcesClient) Delete(ctx context.Context, id commonids.ScopeId) (result DeleteOperationResponse, err error)

Delete ...

func (ResourcesClient) DeleteById 

func (c ResourcesClient) DeleteById(ctx context.Context, id commonids.ScopeId) (result DeleteByIdOperationResponse, err error)

DeleteById ...

func (ResourcesClient) DeleteByIdThenPoll 

func (c ResourcesClient) DeleteByIdThenPoll(ctx context.Context, id commonids.ScopeId) error

DeleteByIdThenPoll performs DeleteById then polls until it's completed

func (ResourcesClient) DeleteThenPoll 

func (c ResourcesClient) DeleteThenPoll(ctx context.Context, id commonids.ScopeId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ResourcesClient) Get 

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

Get ...

func (ResourcesClient) GetById 

func (c ResourcesClient) GetById(ctx context.Context, id commonids.ScopeId) (result GetByIdOperationResponse, err error)

GetById ...

func (ResourcesClient) List 

func (c ResourcesClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (ResourcesClient) ListComplete 

func (c ResourcesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ResourcesClient) ListCompleteMatchingPredicate 

func (c ResourcesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate GenericResourceExpandedOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourcesClient) MoveResources 

func (c ResourcesClient) MoveResources(ctx context.Context, id commonids.ResourceGroupId, input ResourcesMoveInfo) (result MoveResourcesOperationResponse, err error)

MoveResources ...

func (ResourcesClient) MoveResourcesThenPoll 

func (c ResourcesClient) MoveResourcesThenPoll(ctx context.Context, id commonids.ResourceGroupId, input ResourcesMoveInfo) error

MoveResourcesThenPoll performs MoveResources then polls until it's completed

func (ResourcesClient) Update 

func (c ResourcesClient) Update(ctx context.Context, id commonids.ScopeId, input GenericResource) (result UpdateOperationResponse, err error)

Update ...

func (ResourcesClient) UpdateById 

func (c ResourcesClient) UpdateById(ctx context.Context, id commonids.ScopeId, input GenericResource) (result UpdateByIdOperationResponse, err error)

UpdateById ...

func (ResourcesClient) UpdateByIdThenPoll 

func (c ResourcesClient) UpdateByIdThenPoll(ctx context.Context, id commonids.ScopeId, input GenericResource) error

UpdateByIdThenPoll performs UpdateById then polls until it's completed

func (ResourcesClient) UpdateThenPoll 

func (c ResourcesClient) UpdateThenPoll(ctx context.Context, id commonids.ScopeId, input GenericResource) error

UpdateThenPoll performs Update then polls until it's completed

func (ResourcesClient) ValidateMoveResources 

func (c ResourcesClient) ValidateMoveResources(ctx context.Context, id commonids.ResourceGroupId, input ResourcesMoveInfo) (result ValidateMoveResourcesOperationResponse, err error)

ValidateMoveResources ...

func (ResourcesClient) ValidateMoveResourcesThenPoll 

func (c ResourcesClient) ValidateMoveResourcesThenPoll(ctx context.Context, id commonids.ResourceGroupId, input ResourcesMoveInfo) error

ValidateMoveResourcesThenPoll performs ValidateMoveResources then polls until it's completed

type ResourcesMoveInfo 

type ResourcesMoveInfo struct {
	Resources           *[]string `json:"resources,omitempty"`
	TargetResourceGroup *string   `json:"targetResourceGroup,omitempty"`
}

type Sku 

type Sku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Family   *string `json:"family,omitempty"`
	Model    *string `json:"model,omitempty"`
	Name     *string `json:"name,omitempty"`
	Size     *string `json:"size,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

type UpdateByIdOperationResponse 

type UpdateByIdOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GenericResource
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GenericResource
}

type ValidateMoveResourcesOperationResponse 

type ValidateMoveResourcesOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

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.