webcategories

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-09-01/webcategories Documentation

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

Client Initialization

client := webcategories.NewWebCategoriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WebCategoriesClient.Get

ctx := context.TODO()
id := webcategories.NewAzureWebCategoryID("12345678-1234-9876-4563-123456789012", "azureWebCategoryValue")

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

Example Usage: WebCategoriesClient.ListBySubscription

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

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

Documentation

Index

• func ValidateAzureWebCategoryID(input interface{}, key string) (warnings []string, errors []error)
• type AzureWebCategory
• type AzureWebCategoryId
  • func NewAzureWebCategoryID(subscriptionId string, azureWebCategoryName string) AzureWebCategoryId
  • func ParseAzureWebCategoryID(input string) (*AzureWebCategoryId, error)
  • func ParseAzureWebCategoryIDInsensitively(input string) (*AzureWebCategoryId, error)
  • func (id *AzureWebCategoryId) FromParseResult(input resourceids.ParseResult) error
  • func (id AzureWebCategoryId) ID() string
  • func (id AzureWebCategoryId) Segments() []resourceids.Segment
  • func (id AzureWebCategoryId) String() string
• type AzureWebCategoryOperationPredicate
  • func (p AzureWebCategoryOperationPredicate) Matches(input AzureWebCategory) bool
• type AzureWebCategoryPropertiesFormat
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
  • func (o GetOperationOptions) ToHeaders() *client.Headers
  • func (o GetOperationOptions) ToOData() *odata.Query
  • func (o GetOperationOptions) ToQuery() *client.QueryParams
• type GetOperationResponse
• type ListBySubscriptionCompleteResult
• type ListBySubscriptionOperationResponse
• type WebCategoriesClient
  • func NewWebCategoriesClientWithBaseURI(sdkApi sdkEnv.Api) (*WebCategoriesClient, error)
  • func (c WebCategoriesClient) Get(ctx context.Context, id AzureWebCategoryId, options GetOperationOptions) (result GetOperationResponse, err error)
  • func (c WebCategoriesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
  • func (c WebCategoriesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
  • func (c WebCategoriesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)

Functions

func ValidateAzureWebCategoryID

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

ValidateAzureWebCategoryID checks that 'input' can be parsed as a Azure Web Category ID

Types

type AzureWebCategory

type AzureWebCategory struct {
	Etag       *string                           `json:"etag,omitempty"`
	Id         *string                           `json:"id,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *AzureWebCategoryPropertiesFormat `json:"properties,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type AzureWebCategoryId

type AzureWebCategoryId struct {
	SubscriptionId       string
	AzureWebCategoryName string
}

AzureWebCategoryId is a struct representing the Resource ID for a Azure Web Category

func NewAzureWebCategoryID

func NewAzureWebCategoryID(subscriptionId string, azureWebCategoryName string) AzureWebCategoryId

NewAzureWebCategoryID returns a new AzureWebCategoryId struct

func ParseAzureWebCategoryID

func ParseAzureWebCategoryID(input string) (*AzureWebCategoryId, error)

ParseAzureWebCategoryID parses 'input' into a AzureWebCategoryId

func ParseAzureWebCategoryIDInsensitively

func ParseAzureWebCategoryIDInsensitively(input string) (*AzureWebCategoryId, error)

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

func (*AzureWebCategoryId) FromParseResult

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

func (AzureWebCategoryId) ID

func (id AzureWebCategoryId) ID() string

ID returns the formatted Azure Web Category ID

func (AzureWebCategoryId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Azure Web Category ID

func (AzureWebCategoryId) String

func (id AzureWebCategoryId) String() string

String returns a human-readable description of this Azure Web Category ID

type AzureWebCategoryOperationPredicate

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

func (AzureWebCategoryOperationPredicate) Matches

func (p AzureWebCategoryOperationPredicate) Matches(input AzureWebCategory) bool

type AzureWebCategoryPropertiesFormat

type AzureWebCategoryPropertiesFormat struct {
	Group *string `json:"group,omitempty"`
}

type GetOperationOptions

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders

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

func (GetOperationOptions) ToOData

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

func (GetOperationOptions) ToQuery

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

type GetOperationResponse

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

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureWebCategory
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureWebCategory
}

type WebCategoriesClient

type WebCategoriesClient struct {
	Client *resourcemanager.Client
}

func NewWebCategoriesClientWithBaseURI

func NewWebCategoriesClientWithBaseURI(sdkApi sdkEnv.Api) (*WebCategoriesClient, error)

func (WebCategoriesClient) Get

func (c WebCategoriesClient) Get(ctx context.Context, id AzureWebCategoryId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (WebCategoriesClient) ListBySubscription

func (c WebCategoriesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (WebCategoriesClient) ListBySubscriptionComplete

func (c WebCategoriesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (WebCategoriesClient) ListBySubscriptionCompleteMatchingPredicate

func (c WebCategoriesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AzureWebCategoryOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate