blobinventorypolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2021-04-01/blobinventorypolicies Documentation

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

Client Initialization

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

Example Usage: BlobInventoryPoliciesClient.CreateOrUpdate

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

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 := blobinventorypolicies.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

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 := blobinventorypolicies.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

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 := blobinventorypolicies.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

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
• func ValidateStorageAccountID(input interface{}, key string) (warnings []string, errors []error)
• type BlobInventoryPoliciesClient
  • func NewBlobInventoryPoliciesClientWithBaseURI(endpoint string) BlobInventoryPoliciesClient
  • func (c BlobInventoryPoliciesClient) CreateOrUpdate(ctx context.Context, id StorageAccountId, input BlobInventoryPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c BlobInventoryPoliciesClient) Delete(ctx context.Context, id StorageAccountId) (result DeleteOperationResponse, err error)
  • func (c BlobInventoryPoliciesClient) Get(ctx context.Context, id StorageAccountId) (result GetOperationResponse, err error)
  • func (c BlobInventoryPoliciesClient) List(ctx context.Context, id 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
• type GetOperationResponse
• type InventoryRuleType
• type ListBlobInventoryPolicy
• type ListOperationResponse
• type ObjectType
• type Schedule
• type StorageAccountId
  • func NewStorageAccountID(subscriptionId string, resourceGroupName string, accountName string) StorageAccountId
  • func ParseStorageAccountID(input string) (*StorageAccountId, error)
  • func ParseStorageAccountIDInsensitively(input string) (*StorageAccountId, error)
  • func (id StorageAccountId) ID() string
  • func (id StorageAccountId) Segments() []resourceids.Segment
  • func (id StorageAccountId) String() string

Functions

func PossibleValuesForFormat

func PossibleValuesForFormat() []string

func PossibleValuesForInventoryRuleType

func PossibleValuesForInventoryRuleType() []string

func PossibleValuesForObjectType

func PossibleValuesForObjectType() []string

func PossibleValuesForSchedule

func PossibleValuesForSchedule() []string

func ValidateStorageAccountID

func ValidateStorageAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateStorageAccountID checks that 'input' can be parsed as a Storage Account ID

Types

type BlobInventoryPoliciesClient

type BlobInventoryPoliciesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewBlobInventoryPoliciesClientWithBaseURI

func NewBlobInventoryPoliciesClientWithBaseURI(endpoint string) BlobInventoryPoliciesClient

func (BlobInventoryPoliciesClient) CreateOrUpdate

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

CreateOrUpdate ...

func (BlobInventoryPoliciesClient) Delete

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

Delete ...

func (BlobInventoryPoliciesClient) Get

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

Get ...

func (BlobInventoryPoliciesClient) List

func (c BlobInventoryPoliciesClient) List(ctx context.Context, id 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"`
	IncludeBlobVersions *bool     `json:"includeBlobVersions,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 {
	Enabled bool                      `json:"enabled"`
	Rules   []BlobInventoryPolicyRule `json:"rules"`
	Type    InventoryRuleType         `json:"type"`
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type Format

type Format string

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

type GetOperationResponse

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

type InventoryRuleType

type InventoryRuleType string

const (
	InventoryRuleTypeInventory InventoryRuleType = "Inventory"
)

type ListBlobInventoryPolicy

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

type ListOperationResponse

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

type ObjectType

type ObjectType string

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

type Schedule

type Schedule string

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

type StorageAccountId

type StorageAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

StorageAccountId is a struct representing the Resource ID for a Storage Account

func NewStorageAccountID

func NewStorageAccountID(subscriptionId string, resourceGroupName string, accountName string) StorageAccountId

NewStorageAccountID returns a new StorageAccountId struct

func ParseStorageAccountID

func ParseStorageAccountID(input string) (*StorageAccountId, error)

ParseStorageAccountID parses 'input' into a StorageAccountId

func ParseStorageAccountIDInsensitively

func ParseStorageAccountIDInsensitively(input string) (*StorageAccountId, error)

ParseStorageAccountIDInsensitively parses 'input' case-insensitively into a StorageAccountId note: this method should only be used for API response data and not user input

func (StorageAccountId) ID

func (id StorageAccountId) ID() string

ID returns the formatted Storage Account ID

func (StorageAccountId) Segments

func (id StorageAccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Storage Account ID

func (StorageAccountId) String

func (id StorageAccountId) String() string

String returns a human-readable description of this Storage Account ID