raiblocklists

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/raiblocklists Documentation

The raiblocklists SDK allows for interaction with Azure Resource Manager cognitive (API Version 2024-10-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/cognitive/2024-10-01/raiblocklists"

Client Initialization

client := raiblocklists.NewRaiBlocklistsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RaiBlocklistsClient.CreateOrUpdate

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName")

payload := raiblocklists.RaiBlocklist{
	// ...
}


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

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName")

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

Example Usage: RaiBlocklistsClient.Get

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName")

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

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

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

Example Usage: RaiBlocklistsClient.RaiBlocklistItemsBatchAdd

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName")
var payload []RaiBlocklistItemBulkRequest

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

Example Usage: RaiBlocklistsClient.RaiBlocklistItemsBatchDelete

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName")
var payload interface{}

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

Example Usage: RaiBlocklistsClient.RaiBlocklistItemsCreateOrUpdate

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName", "raiBlocklistItemName")

payload := raiblocklists.RaiBlocklistItem{
	// ...
}


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

Example Usage: RaiBlocklistsClient.RaiBlocklistItemsDelete

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName", "raiBlocklistItemName")

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

Example Usage: RaiBlocklistsClient.RaiBlocklistItemsGet

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName", "raiBlocklistItemName")

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

Example Usage: RaiBlocklistsClient.RaiBlocklistItemsList

ctx := context.TODO()
id := raiblocklists.NewRaiBlocklistID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "raiBlocklistName")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateAccountID 

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

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateRaiBlocklistID 

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

ValidateRaiBlocklistID checks that 'input' can be parsed as a Rai Blocklist ID

func ValidateRaiBlocklistItemID 

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

ValidateRaiBlocklistItemID checks that 'input' can be parsed as a Rai Blocklist Item ID

Types

type AccountId 

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID 

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID 

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively 

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult 

func (id *AccountId) FromParseResult(input resourceids.ParseResult) error

func (AccountId) ID 

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments 

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

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

func (AccountId) String 

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

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

type RaiBlocklist 

type RaiBlocklist struct {
	Etag       *string                 `json:"etag,omitempty"`
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *RaiBlocklistProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Tags       *map[string]string      `json:"tags,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type RaiBlocklistId 

type RaiBlocklistId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	RaiBlocklistName  string
}

RaiBlocklistId is a struct representing the Resource ID for a Rai Blocklist

func NewRaiBlocklistID 

func NewRaiBlocklistID(subscriptionId string, resourceGroupName string, accountName string, raiBlocklistName string) RaiBlocklistId

NewRaiBlocklistID returns a new RaiBlocklistId struct

func ParseRaiBlocklistID 

func ParseRaiBlocklistID(input string) (*RaiBlocklistId, error)

ParseRaiBlocklistID parses 'input' into a RaiBlocklistId

func ParseRaiBlocklistIDInsensitively 

func ParseRaiBlocklistIDInsensitively(input string) (*RaiBlocklistId, error)

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

func (*RaiBlocklistId) FromParseResult 

func (id *RaiBlocklistId) FromParseResult(input resourceids.ParseResult) error

func (RaiBlocklistId) ID 

func (id RaiBlocklistId) ID() string

ID returns the formatted Rai Blocklist ID

func (RaiBlocklistId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Rai Blocklist ID

func (RaiBlocklistId) String 

func (id RaiBlocklistId) String() string

String returns a human-readable description of this Rai Blocklist ID

type RaiBlocklistItem 

type RaiBlocklistItem struct {
	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *RaiBlocklistItemProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type RaiBlocklistItemBulkRequest 

type RaiBlocklistItemBulkRequest struct {
	Name       *string                     `json:"name,omitempty"`
	Properties *RaiBlocklistItemProperties `json:"properties,omitempty"`
}

type RaiBlocklistItemId 

type RaiBlocklistItemId struct {
	SubscriptionId       string
	ResourceGroupName    string
	AccountName          string
	RaiBlocklistName     string
	RaiBlocklistItemName string
}

RaiBlocklistItemId is a struct representing the Resource ID for a Rai Blocklist Item

func NewRaiBlocklistItemID 

func NewRaiBlocklistItemID(subscriptionId string, resourceGroupName string, accountName string, raiBlocklistName string, raiBlocklistItemName string) RaiBlocklistItemId

NewRaiBlocklistItemID returns a new RaiBlocklistItemId struct

func ParseRaiBlocklistItemID 

func ParseRaiBlocklistItemID(input string) (*RaiBlocklistItemId, error)

ParseRaiBlocklistItemID parses 'input' into a RaiBlocklistItemId

func ParseRaiBlocklistItemIDInsensitively 

func ParseRaiBlocklistItemIDInsensitively(input string) (*RaiBlocklistItemId, error)

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

func (*RaiBlocklistItemId) FromParseResult 

func (id *RaiBlocklistItemId) FromParseResult(input resourceids.ParseResult) error

func (RaiBlocklistItemId) ID 

func (id RaiBlocklistItemId) ID() string

ID returns the formatted Rai Blocklist Item ID

func (RaiBlocklistItemId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Rai Blocklist Item ID

func (RaiBlocklistItemId) String 

func (id RaiBlocklistItemId) String() string

String returns a human-readable description of this Rai Blocklist Item ID

type RaiBlocklistItemOperationPredicate 

type RaiBlocklistItemOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (RaiBlocklistItemOperationPredicate) Matches 

func (p RaiBlocklistItemOperationPredicate) Matches(input RaiBlocklistItem) bool

type RaiBlocklistItemProperties 

type RaiBlocklistItemProperties struct {
	IsRegex *bool   `json:"isRegex,omitempty"`
	Pattern *string `json:"pattern,omitempty"`
}

type RaiBlocklistItemsBatchAddOperationResponse 

type RaiBlocklistItemsBatchAddOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RaiBlocklist
}

type RaiBlocklistItemsBatchDeleteOperationResponse 

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

type RaiBlocklistItemsCreateOrUpdateOperationResponse 

type RaiBlocklistItemsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RaiBlocklistItem
}

type RaiBlocklistItemsDeleteOperationResponse 

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

type RaiBlocklistItemsGetOperationResponse 

type RaiBlocklistItemsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RaiBlocklistItem
}

type RaiBlocklistItemsListCompleteResult 

type RaiBlocklistItemsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RaiBlocklistItem
}

type RaiBlocklistItemsListCustomPager 

type RaiBlocklistItemsListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *RaiBlocklistItemsListCustomPager) NextPageLink() *odata.Link

type RaiBlocklistItemsListOperationResponse 

type RaiBlocklistItemsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RaiBlocklistItem
}

type RaiBlocklistOperationPredicate 

type RaiBlocklistOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (RaiBlocklistOperationPredicate) Matches 

func (p RaiBlocklistOperationPredicate) Matches(input RaiBlocklist) bool

type RaiBlocklistProperties 

type RaiBlocklistProperties struct {
	Description *string `json:"description,omitempty"`
}

type RaiBlocklistsClient 

type RaiBlocklistsClient struct {
	Client *resourcemanager.Client
}

func NewRaiBlocklistsClientWithBaseURI 

func NewRaiBlocklistsClientWithBaseURI(sdkApi sdkEnv.Api) (*RaiBlocklistsClient, error)

func (RaiBlocklistsClient) CreateOrUpdate 

func (c RaiBlocklistsClient) CreateOrUpdate(ctx context.Context, id RaiBlocklistId, input RaiBlocklist) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (RaiBlocklistsClient) Delete 

func (c RaiBlocklistsClient) Delete(ctx context.Context, id RaiBlocklistId) (result DeleteOperationResponse, err error)

Delete ...

func (RaiBlocklistsClient) DeleteThenPoll 

func (c RaiBlocklistsClient) DeleteThenPoll(ctx context.Context, id RaiBlocklistId) error

DeleteThenPoll performs Delete then polls until it's completed

func (RaiBlocklistsClient) Get 

func (c RaiBlocklistsClient) Get(ctx context.Context, id RaiBlocklistId) (result GetOperationResponse, err error)

Get ...

func (RaiBlocklistsClient) List 

func (c RaiBlocklistsClient) List(ctx context.Context, id AccountId) (result ListOperationResponse, err error)

List ...

func (RaiBlocklistsClient) ListComplete 

func (c RaiBlocklistsClient) ListComplete(ctx context.Context, id AccountId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (RaiBlocklistsClient) ListCompleteMatchingPredicate 

func (c RaiBlocklistsClient) ListCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate RaiBlocklistOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RaiBlocklistsClient) RaiBlocklistItemsBatchAdd 

func (c RaiBlocklistsClient) RaiBlocklistItemsBatchAdd(ctx context.Context, id RaiBlocklistId, input []RaiBlocklistItemBulkRequest) (result RaiBlocklistItemsBatchAddOperationResponse, err error)

RaiBlocklistItemsBatchAdd ...

func (RaiBlocklistsClient) RaiBlocklistItemsBatchDelete 

func (c RaiBlocklistsClient) RaiBlocklistItemsBatchDelete(ctx context.Context, id RaiBlocklistId, input interface{}) (result RaiBlocklistItemsBatchDeleteOperationResponse, err error)

RaiBlocklistItemsBatchDelete ...

func (RaiBlocklistsClient) RaiBlocklistItemsCreateOrUpdate 

func (c RaiBlocklistsClient) RaiBlocklistItemsCreateOrUpdate(ctx context.Context, id RaiBlocklistItemId, input RaiBlocklistItem) (result RaiBlocklistItemsCreateOrUpdateOperationResponse, err error)

RaiBlocklistItemsCreateOrUpdate ...

func (RaiBlocklistsClient) RaiBlocklistItemsDelete 

func (c RaiBlocklistsClient) RaiBlocklistItemsDelete(ctx context.Context, id RaiBlocklistItemId) (result RaiBlocklistItemsDeleteOperationResponse, err error)

RaiBlocklistItemsDelete ...

func (RaiBlocklistsClient) RaiBlocklistItemsDeleteThenPoll 

func (c RaiBlocklistsClient) RaiBlocklistItemsDeleteThenPoll(ctx context.Context, id RaiBlocklistItemId) error

RaiBlocklistItemsDeleteThenPoll performs RaiBlocklistItemsDelete then polls until it's completed

func (RaiBlocklistsClient) RaiBlocklistItemsGet 

func (c RaiBlocklistsClient) RaiBlocklistItemsGet(ctx context.Context, id RaiBlocklistItemId) (result RaiBlocklistItemsGetOperationResponse, err error)

RaiBlocklistItemsGet ...

func (RaiBlocklistsClient) RaiBlocklistItemsList 

func (c RaiBlocklistsClient) RaiBlocklistItemsList(ctx context.Context, id RaiBlocklistId) (result RaiBlocklistItemsListOperationResponse, err error)

RaiBlocklistItemsList ...

func (RaiBlocklistsClient) RaiBlocklistItemsListComplete 

func (c RaiBlocklistsClient) RaiBlocklistItemsListComplete(ctx context.Context, id RaiBlocklistId) (RaiBlocklistItemsListCompleteResult, error)

RaiBlocklistItemsListComplete retrieves all the results into a single object

func (RaiBlocklistsClient) RaiBlocklistItemsListCompleteMatchingPredicate 

func (c RaiBlocklistsClient) RaiBlocklistItemsListCompleteMatchingPredicate(ctx context.Context, id RaiBlocklistId, predicate RaiBlocklistItemOperationPredicate) (result RaiBlocklistItemsListCompleteResult, err error)

RaiBlocklistItemsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.