resourcegroups

package
v0.20240604.1114748 Latest Latest
Warning

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

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

README

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

The resourcegroups SDK allows for interaction with the Azure Resource Manager Service 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/resourcegroups"

Client Initialization

client := resourcegroups.NewResourceGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourceGroupsClient.CheckExistence

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-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: ResourceGroupsClient.CreateOrUpdate

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

payload := resourcegroups.ResourceGroup{
	// ...
}


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

Example Usage: ResourceGroupsClient.Delete

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

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

Example Usage: ResourceGroupsClient.Get

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-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: ResourceGroupsClient.List

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

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

Example Usage: ResourceGroupsClient.ListResources

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

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

Example Usage: ResourceGroupsClient.Patch

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

payload := resourcegroups.ResourceGroup{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckExistenceOperationResponse 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceGroup
}

type DeleteOperationResponse 

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

type GenericResourceExpanded 

type GenericResourceExpanded struct {
	ChangedTime       *string            `json:"changedTime,omitempty"`
	CreatedTime       *string            `json:"createdTime,omitempty"`
	Id                *string            `json:"id,omitempty"`
	Location          string             `json:"location"`
	Name              *string            `json:"name,omitempty"`
	Plan              *Plan              `json:"plan,omitempty"`
	Properties        *interface{}       `json:"properties,omitempty"`
	ProvisioningState *string            `json:"provisioningState,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
	Location          *string
	Name              *string
	Properties        *interface{}
	ProvisioningState *string
	Type              *string
}

func (GenericResourceExpandedOperationPredicate) Matches 

func (p GenericResourceExpandedOperationPredicate) Matches(input GenericResourceExpanded) bool

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListOperationOptions 

type ListOperationOptions struct {
	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        *[]ResourceGroup
}

type ListResourcesCompleteResult 

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

type ListResourcesOperationOptions 

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

func DefaultListResourcesOperationOptions 

func DefaultListResourcesOperationOptions() ListResourcesOperationOptions

func (ListResourcesOperationOptions) ToHeaders 

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

func (ListResourcesOperationOptions) ToOData 

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

func (ListResourcesOperationOptions) ToQuery 

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

type ListResourcesOperationResponse 

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

type PatchOperationResponse 

type PatchOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceGroup
}

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"`
}

type ResourceGroup 

type ResourceGroup struct {
	Id         *string                  `json:"id,omitempty"`
	Location   string                   `json:"location"`
	Name       *string                  `json:"name,omitempty"`
	Properties *ResourceGroupProperties `json:"properties,omitempty"`
	Tags       *map[string]string       `json:"tags,omitempty"`
}

type ResourceGroupOperationPredicate 

type ResourceGroupOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
}

func (ResourceGroupOperationPredicate) Matches 

func (p ResourceGroupOperationPredicate) Matches(input ResourceGroup) bool

type ResourceGroupProperties 

type ResourceGroupProperties struct {
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

type ResourceGroupsClient 

type ResourceGroupsClient struct {
	Client *resourcemanager.Client
}

func NewResourceGroupsClientWithBaseURI 

func NewResourceGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourceGroupsClient, error)

func (ResourceGroupsClient) CheckExistence 

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

CheckExistence ...

func (ResourceGroupsClient) CreateOrUpdate 

func (c ResourceGroupsClient) CreateOrUpdate(ctx context.Context, id commonids.ResourceGroupId, input ResourceGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ResourceGroupsClient) Delete 

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

Delete ...

func (ResourceGroupsClient) DeleteThenPoll 

func (c ResourceGroupsClient) DeleteThenPoll(ctx context.Context, id commonids.ResourceGroupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ResourceGroupsClient) Get 

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

Get ...

func (ResourceGroupsClient) List 

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

List ...

func (ResourceGroupsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ResourceGroupsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceGroupsClient) ListResources 

func (c ResourceGroupsClient) ListResources(ctx context.Context, id commonids.ResourceGroupId, options ListResourcesOperationOptions) (result ListResourcesOperationResponse, err error)

ListResources ...

func (ResourceGroupsClient) ListResourcesComplete 

func (c ResourceGroupsClient) ListResourcesComplete(ctx context.Context, id commonids.ResourceGroupId, options ListResourcesOperationOptions) (ListResourcesCompleteResult, error)

ListResourcesComplete retrieves all the results into a single object

func (ResourceGroupsClient) ListResourcesCompleteMatchingPredicate 

func (c ResourceGroupsClient) ListResourcesCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListResourcesOperationOptions, predicate GenericResourceExpandedOperationPredicate) (result ListResourcesCompleteResult, err error)

ListResourcesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceGroupsClient) Patch 

func (c ResourceGroupsClient) Patch(ctx context.Context, id commonids.ResourceGroupId, input ResourceGroup) (result PatchOperationResponse, err error)

Patch ...

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.