virtualnetworkrules

package
v0.20231212.1221926 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/datalakestore/2016-11-01/virtualnetworkrules Documentation

The virtualnetworkrules SDK allows for interaction with the Azure Resource Manager Service datalakestore (API Version 2016-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-sdk/resource-manager/datalakestore/2016-11-01/virtualnetworkrules"

Client Initialization

client := virtualnetworkrules.NewVirtualNetworkRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualNetworkRulesClient.CreateOrUpdate

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

payload := virtualnetworkrules.CreateOrUpdateVirtualNetworkRuleParameters{
	// ...
}


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

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

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: VirtualNetworkRulesClient.Get

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

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: VirtualNetworkRulesClient.ListByAccount

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

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

Example Usage: VirtualNetworkRulesClient.Update

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

payload := virtualnetworkrules.UpdateVirtualNetworkRuleParameters{
	// ...
}


read, err := client.Update(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

func ValidateAccountID 

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

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

func ValidateVirtualNetworkRuleID 

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

ValidateVirtualNetworkRuleID checks that 'input' can be parsed as a Virtual Network Rule 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 added in v0.20231127.1171502 

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        *VirtualNetworkRule
}

type CreateOrUpdateVirtualNetworkRuleParameters 

type CreateOrUpdateVirtualNetworkRuleParameters struct {
	Properties CreateOrUpdateVirtualNetworkRuleProperties `json:"properties"`
}

type CreateOrUpdateVirtualNetworkRuleProperties 

type CreateOrUpdateVirtualNetworkRuleProperties struct {
	SubnetId string `json:"subnetId"`
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByAccountCompleteResult 

type ListByAccountCompleteResult struct {
	Items []VirtualNetworkRule
}

type ListByAccountOperationResponse 

type ListByAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VirtualNetworkRule
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VirtualNetworkRule
}

type UpdateVirtualNetworkRuleParameters 

type UpdateVirtualNetworkRuleParameters struct {
	Properties *UpdateVirtualNetworkRuleProperties `json:"properties,omitempty"`
}

type UpdateVirtualNetworkRuleProperties 

type UpdateVirtualNetworkRuleProperties struct {
	SubnetId *string `json:"subnetId,omitempty"`
}

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	Id         *string                       `json:"id,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *VirtualNetworkRuleProperties `json:"properties,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type VirtualNetworkRuleId 

type VirtualNetworkRuleId struct {
	SubscriptionId         string
	ResourceGroupName      string
	AccountName            string
	VirtualNetworkRuleName string
}

VirtualNetworkRuleId is a struct representing the Resource ID for a Virtual Network Rule

func NewVirtualNetworkRuleID 

func NewVirtualNetworkRuleID(subscriptionId string, resourceGroupName string, accountName string, virtualNetworkRuleName string) VirtualNetworkRuleId

NewVirtualNetworkRuleID returns a new VirtualNetworkRuleId struct

func ParseVirtualNetworkRuleID 

func ParseVirtualNetworkRuleID(input string) (*VirtualNetworkRuleId, error)

ParseVirtualNetworkRuleID parses 'input' into a VirtualNetworkRuleId

func ParseVirtualNetworkRuleIDInsensitively 

func ParseVirtualNetworkRuleIDInsensitively(input string) (*VirtualNetworkRuleId, error)

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

func (*VirtualNetworkRuleId) FromParseResult added in v0.20231127.1171502 

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

func (VirtualNetworkRuleId) ID 

func (id VirtualNetworkRuleId) ID() string

ID returns the formatted Virtual Network Rule ID

func (VirtualNetworkRuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Virtual Network Rule ID

func (VirtualNetworkRuleId) String 

func (id VirtualNetworkRuleId) String() string

String returns a human-readable description of this Virtual Network Rule ID

type VirtualNetworkRuleOperationPredicate 

type VirtualNetworkRuleOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (VirtualNetworkRuleOperationPredicate) Matches 

func (p VirtualNetworkRuleOperationPredicate) Matches(input VirtualNetworkRule) bool

type VirtualNetworkRuleProperties 

type VirtualNetworkRuleProperties struct {
	SubnetId *string `json:"subnetId,omitempty"`
}

type VirtualNetworkRulesClient 

type VirtualNetworkRulesClient struct {
	Client *resourcemanager.Client
}

func NewVirtualNetworkRulesClientWithBaseURI 

func NewVirtualNetworkRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualNetworkRulesClient, error)

func (VirtualNetworkRulesClient) CreateOrUpdate 

func (c VirtualNetworkRulesClient) CreateOrUpdate(ctx context.Context, id VirtualNetworkRuleId, input CreateOrUpdateVirtualNetworkRuleParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (VirtualNetworkRulesClient) Delete 

func (c VirtualNetworkRulesClient) Delete(ctx context.Context, id VirtualNetworkRuleId) (result DeleteOperationResponse, err error)

Delete ...

func (VirtualNetworkRulesClient) Get 

func (c VirtualNetworkRulesClient) Get(ctx context.Context, id VirtualNetworkRuleId) (result GetOperationResponse, err error)

Get ...

func (VirtualNetworkRulesClient) ListByAccount 

func (c VirtualNetworkRulesClient) ListByAccount(ctx context.Context, id AccountId) (result ListByAccountOperationResponse, err error)

ListByAccount ...

func (VirtualNetworkRulesClient) ListByAccountComplete 

func (c VirtualNetworkRulesClient) ListByAccountComplete(ctx context.Context, id AccountId) (ListByAccountCompleteResult, error)

ListByAccountComplete retrieves all the results into a single object

func (VirtualNetworkRulesClient) ListByAccountCompleteMatchingPredicate 

func (c VirtualNetworkRulesClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate VirtualNetworkRuleOperationPredicate) (result ListByAccountCompleteResult, err error)

ListByAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualNetworkRulesClient) Update 

func (c VirtualNetworkRulesClient) Update(ctx context.Context, id VirtualNetworkRuleId, input UpdateVirtualNetworkRuleParameters) (result UpdateOperationResponse, err error)

Update ...

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.