privatelinkforazuread

package
v0.20240320.1143605 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/azureactivedirectory/2020-03-01/privatelinkforazuread Documentation

The privatelinkforazuread SDK allows for interaction with the Azure Resource Manager Service azureactivedirectory (API Version 2020-03-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/azureactivedirectory/2020-03-01/privatelinkforazuread"

Client Initialization

client := privatelinkforazuread.NewPrivateLinkForAzureAdClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkForAzureAdClient.Create

ctx := context.TODO()
id := privatelinkforazuread.NewPrivateLinkForAzureAdID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkForAzureAdValue")

payload := privatelinkforazuread.PrivateLinkPolicy{
	// ...
}


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

Example Usage: PrivateLinkForAzureAdClient.Delete

ctx := context.TODO()
id := privatelinkforazuread.NewPrivateLinkForAzureAdID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkForAzureAdValue")

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

ctx := context.TODO()
id := privatelinkforazuread.NewPrivateLinkForAzureAdID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkForAzureAdValue")

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

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

// 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: PrivateLinkForAzureAdClient.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
}

Example Usage: PrivateLinkForAzureAdClient.Update

ctx := context.TODO()
id := privatelinkforazuread.NewPrivateLinkForAzureAdID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkForAzureAdValue")

payload := privatelinkforazuread.PrivateLinkPolicyUpdateParameter{
	// ...
}


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 ValidatePrivateLinkForAzureAdID 

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

ValidatePrivateLinkForAzureAdID checks that 'input' can be parsed as a Private Link For Azure Ad ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkPolicy
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

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

type PrivateLinkForAzureAdClient 

type PrivateLinkForAzureAdClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkForAzureAdClientWithBaseURI 

func NewPrivateLinkForAzureAdClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkForAzureAdClient, error)

func (PrivateLinkForAzureAdClient) Create 

func (c PrivateLinkForAzureAdClient) Create(ctx context.Context, id PrivateLinkForAzureAdId, input PrivateLinkPolicy) (result CreateOperationResponse, err error)

Create ...

func (PrivateLinkForAzureAdClient) CreateThenPoll 

func (c PrivateLinkForAzureAdClient) CreateThenPoll(ctx context.Context, id PrivateLinkForAzureAdId, input PrivateLinkPolicy) error

CreateThenPoll performs Create then polls until it's completed

func (PrivateLinkForAzureAdClient) Delete 

func (c PrivateLinkForAzureAdClient) Delete(ctx context.Context, id PrivateLinkForAzureAdId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateLinkForAzureAdClient) Get 

func (c PrivateLinkForAzureAdClient) Get(ctx context.Context, id PrivateLinkForAzureAdId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkForAzureAdClient) List 

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

List ...

func (PrivateLinkForAzureAdClient) ListBySubscription 

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

ListBySubscription ...

func (PrivateLinkForAzureAdClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (PrivateLinkForAzureAdClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkForAzureAdClient) ListComplete 

func (c PrivateLinkForAzureAdClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PrivateLinkForAzureAdClient) ListCompleteMatchingPredicate 

func (c PrivateLinkForAzureAdClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate PrivateLinkPolicyOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkForAzureAdClient) Update 

func (c PrivateLinkForAzureAdClient) Update(ctx context.Context, id PrivateLinkForAzureAdId, input PrivateLinkPolicyUpdateParameter) (result UpdateOperationResponse, err error)

Update ...

type PrivateLinkForAzureAdId 

type PrivateLinkForAzureAdId struct {
	SubscriptionId            string
	ResourceGroupName         string
	PrivateLinkForAzureAdName string
}

PrivateLinkForAzureAdId is a struct representing the Resource ID for a Private Link For Azure Ad

func NewPrivateLinkForAzureAdID 

func NewPrivateLinkForAzureAdID(subscriptionId string, resourceGroupName string, privateLinkForAzureAdName string) PrivateLinkForAzureAdId

NewPrivateLinkForAzureAdID returns a new PrivateLinkForAzureAdId struct

func ParsePrivateLinkForAzureAdID 

func ParsePrivateLinkForAzureAdID(input string) (*PrivateLinkForAzureAdId, error)

ParsePrivateLinkForAzureAdID parses 'input' into a PrivateLinkForAzureAdId

func ParsePrivateLinkForAzureAdIDInsensitively 

func ParsePrivateLinkForAzureAdIDInsensitively(input string) (*PrivateLinkForAzureAdId, error)

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

func (*PrivateLinkForAzureAdId) FromParseResult 

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

func (PrivateLinkForAzureAdId) ID 

func (id PrivateLinkForAzureAdId) ID() string

ID returns the formatted Private Link For Azure Ad ID

func (PrivateLinkForAzureAdId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Link For Azure Ad ID

func (PrivateLinkForAzureAdId) String 

func (id PrivateLinkForAzureAdId) String() string

String returns a human-readable description of this Private Link For Azure Ad ID

type PrivateLinkPolicy 

type PrivateLinkPolicy struct {
	AllTenants     *bool              `json:"allTenants,omitempty"`
	Id             *string            `json:"id,omitempty"`
	Name           *string            `json:"name,omitempty"`
	OwnerTenantId  *string            `json:"ownerTenantId,omitempty"`
	ResourceGroup  *string            `json:"resourceGroup,omitempty"`
	ResourceName   *string            `json:"resourceName,omitempty"`
	SubscriptionId *string            `json:"subscriptionId,omitempty"`
	Tags           *map[string]string `json:"tags,omitempty"`
	Tenants        *[]string          `json:"tenants,omitempty"`
	Type           *string            `json:"type,omitempty"`
}

type PrivateLinkPolicyOperationPredicate 

type PrivateLinkPolicyOperationPredicate struct {
	AllTenants     *bool
	Id             *string
	Name           *string
	OwnerTenantId  *string
	ResourceGroup  *string
	ResourceName   *string
	SubscriptionId *string
	Type           *string
}

func (PrivateLinkPolicyOperationPredicate) Matches 

func (p PrivateLinkPolicyOperationPredicate) Matches(input PrivateLinkPolicy) bool

type PrivateLinkPolicyUpdateParameter 

type PrivateLinkPolicyUpdateParameter struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateOperationResponse 

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

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.