blobinventorypolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/blobinventorypolicies Documentation

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

Client Initialization

client := blobinventorypolicies.NewBlobInventoryPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BlobInventoryPoliciesClient.CreateOrUpdate

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

payload := blobinventorypolicies.BlobInventoryPolicy{
	// ...
}


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: BlobInventoryPoliciesClient.Delete

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

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

Example Usage: BlobInventoryPoliciesClient.Get

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

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: BlobInventoryPoliciesClient.List

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

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

Documentation

Index

• func PossibleValuesForFormat() []string
• func PossibleValuesForInventoryRuleType() []string
• func PossibleValuesForObjectType() []string
• func PossibleValuesForSchedule() []string
• type BlobInventoryCreationTime
• type BlobInventoryPoliciesClient
  • func NewBlobInventoryPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*BlobInventoryPoliciesClient, error)
  • func (c BlobInventoryPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.StorageAccountId, input BlobInventoryPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c BlobInventoryPoliciesClient) Delete(ctx context.Context, id commonids.StorageAccountId) (result DeleteOperationResponse, err error)
  • func (c BlobInventoryPoliciesClient) Get(ctx context.Context, id commonids.StorageAccountId) (result GetOperationResponse, err error)
  • func (c BlobInventoryPoliciesClient) List(ctx context.Context, id commonids.StorageAccountId) (result ListOperationResponse, err error)
• type BlobInventoryPolicy
• type BlobInventoryPolicyDefinition
• type BlobInventoryPolicyFilter
• type BlobInventoryPolicyProperties
  • func (o *BlobInventoryPolicyProperties) GetLastModifiedTimeAsTime() (*time.Time, error)
  • func (o *BlobInventoryPolicyProperties) SetLastModifiedTimeAsTime(input time.Time)
• type BlobInventoryPolicyRule
• type BlobInventoryPolicySchema
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type Format
  • func (s *Format) UnmarshalJSON(bytes []byte) error
• type GetOperationResponse
• type InventoryRuleType
  • func (s *InventoryRuleType) UnmarshalJSON(bytes []byte) error
• type ListBlobInventoryPolicy
• type ListOperationResponse
• type ObjectType
  • func (s *ObjectType) UnmarshalJSON(bytes []byte) error
• type Schedule
  • func (s *Schedule) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForFormat

func PossibleValuesForFormat() []string

func PossibleValuesForInventoryRuleType

func PossibleValuesForInventoryRuleType() []string

func PossibleValuesForObjectType

func PossibleValuesForObjectType() []string

func PossibleValuesForSchedule

func PossibleValuesForSchedule() []string

Types

type BlobInventoryCreationTime

type BlobInventoryCreationTime struct {
	LastNDays *int64 `json:"lastNDays,omitempty"`
}

type BlobInventoryPoliciesClient

type BlobInventoryPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewBlobInventoryPoliciesClientWithBaseURI

func NewBlobInventoryPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*BlobInventoryPoliciesClient, error)

func (BlobInventoryPoliciesClient) CreateOrUpdate

func (c BlobInventoryPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.StorageAccountId, input BlobInventoryPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (BlobInventoryPoliciesClient) Delete

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

Delete ...

func (BlobInventoryPoliciesClient) Get

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

Get ...

func (BlobInventoryPoliciesClient) List

func (c BlobInventoryPoliciesClient) List(ctx context.Context, id commonids.StorageAccountId) (result ListOperationResponse, err error)

List ...

type BlobInventoryPolicy

type BlobInventoryPolicy struct {
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *BlobInventoryPolicyProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type BlobInventoryPolicyDefinition

type BlobInventoryPolicyDefinition struct {
	Filters      *BlobInventoryPolicyFilter `json:"filters,omitempty"`
	Format       Format                     `json:"format"`
	ObjectType   ObjectType                 `json:"objectType"`
	Schedule     Schedule                   `json:"schedule"`
	SchemaFields []string                   `json:"schemaFields"`
}

type BlobInventoryPolicyFilter

type BlobInventoryPolicyFilter struct {
	BlobTypes           *[]string                  `json:"blobTypes,omitempty"`
	CreationTime        *BlobInventoryCreationTime `json:"creationTime,omitempty"`
	ExcludePrefix       *[]string                  `json:"excludePrefix,omitempty"`
	IncludeBlobVersions *bool                      `json:"includeBlobVersions,omitempty"`
	IncludeDeleted      *bool                      `json:"includeDeleted,omitempty"`
	IncludeSnapshots    *bool                      `json:"includeSnapshots,omitempty"`
	PrefixMatch         *[]string                  `json:"prefixMatch,omitempty"`
}

type BlobInventoryPolicyProperties

type BlobInventoryPolicyProperties struct {
	LastModifiedTime *string                   `json:"lastModifiedTime,omitempty"`
	Policy           BlobInventoryPolicySchema `json:"policy"`
}

func (*BlobInventoryPolicyProperties) GetLastModifiedTimeAsTime

func (o *BlobInventoryPolicyProperties) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*BlobInventoryPolicyProperties) SetLastModifiedTimeAsTime

func (o *BlobInventoryPolicyProperties) SetLastModifiedTimeAsTime(input time.Time)

type BlobInventoryPolicyRule

type BlobInventoryPolicyRule struct {
	Definition  BlobInventoryPolicyDefinition `json:"definition"`
	Destination string                        `json:"destination"`
	Enabled     bool                          `json:"enabled"`
	Name        string                        `json:"name"`
}

type BlobInventoryPolicySchema

type BlobInventoryPolicySchema struct {
	Destination *string                   `json:"destination,omitempty"`
	Enabled     bool                      `json:"enabled"`
	Rules       []BlobInventoryPolicyRule `json:"rules"`
	Type        InventoryRuleType         `json:"type"`
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type Format

type Format string

const (
	FormatCsv     Format = "Csv"
	FormatParquet Format = "Parquet"
)

func (*Format) UnmarshalJSON

func (s *Format) UnmarshalJSON(bytes []byte) error

type GetOperationResponse

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

type InventoryRuleType

type InventoryRuleType string

const (
	InventoryRuleTypeInventory InventoryRuleType = "Inventory"
)

func (*InventoryRuleType) UnmarshalJSON

func (s *InventoryRuleType) UnmarshalJSON(bytes []byte) error

type ListBlobInventoryPolicy

type ListBlobInventoryPolicy struct {
	Value *[]BlobInventoryPolicy `json:"value,omitempty"`
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListBlobInventoryPolicy
}

type ObjectType

type ObjectType string

const (
	ObjectTypeBlob      ObjectType = "Blob"
	ObjectTypeContainer ObjectType = "Container"
)

func (*ObjectType) UnmarshalJSON

func (s *ObjectType) UnmarshalJSON(bytes []byte) error

type Schedule

type Schedule string

const (
	ScheduleDaily  Schedule = "Daily"
	ScheduleWeekly Schedule = "Weekly"
)

func (*Schedule) UnmarshalJSON

func (s *Schedule) UnmarshalJSON(bytes []byte) error