managedidentities

package
v0.20240731.1212841 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/managedidentity/2023-01-31/managedidentities Documentation

The managedidentities SDK allows for interaction with the Azure Resource Manager Service managedidentity (API Version 2023-01-31).

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/managedidentity/2023-01-31/managedidentities"

Client Initialization

client := managedidentities.NewManagedIdentitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedIdentitiesClient.FederatedIdentityCredentialsCreateOrUpdate

ctx := context.TODO()
id := managedidentities.NewFederatedIdentityCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "userAssignedIdentityValue", "federatedIdentityCredentialValue")

payload := managedidentities.FederatedIdentityCredential{
	// ...
}


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

Example Usage: ManagedIdentitiesClient.FederatedIdentityCredentialsDelete

ctx := context.TODO()
id := managedidentities.NewFederatedIdentityCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "userAssignedIdentityValue", "federatedIdentityCredentialValue")

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

Example Usage: ManagedIdentitiesClient.FederatedIdentityCredentialsGet

ctx := context.TODO()
id := managedidentities.NewFederatedIdentityCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "userAssignedIdentityValue", "federatedIdentityCredentialValue")

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

Example Usage: ManagedIdentitiesClient.FederatedIdentityCredentialsList

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

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

Example Usage: ManagedIdentitiesClient.SystemAssignedIdentitiesGetByScope

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: ManagedIdentitiesClient.UserAssignedIdentitiesCreateOrUpdate

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

payload := managedidentities.Identity{
	// ...
}


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

Example Usage: ManagedIdentitiesClient.UserAssignedIdentitiesDelete

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

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

Example Usage: ManagedIdentitiesClient.UserAssignedIdentitiesGet

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

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

Example Usage: ManagedIdentitiesClient.UserAssignedIdentitiesListByResourceGroup

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

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

Example Usage: ManagedIdentitiesClient.UserAssignedIdentitiesListBySubscription

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

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

Example Usage: ManagedIdentitiesClient.UserAssignedIdentitiesUpdate

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

payload := managedidentities.IdentityUpdate{
	// ...
}


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

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

ValidateFederatedIdentityCredentialID checks that 'input' can be parsed as a Federated Identity Credential ID

Types

type FederatedIdentityCredential 

type FederatedIdentityCredential struct {
	Id         *string                                `json:"id,omitempty"`
	Name       *string                                `json:"name,omitempty"`
	Properties *FederatedIdentityCredentialProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                 `json:"systemData,omitempty"`
	Type       *string                                `json:"type,omitempty"`
}

type FederatedIdentityCredentialId 

type FederatedIdentityCredentialId struct {
	SubscriptionId                  string
	ResourceGroupName               string
	UserAssignedIdentityName        string
	FederatedIdentityCredentialName string
}

FederatedIdentityCredentialId is a struct representing the Resource ID for a Federated Identity Credential

func NewFederatedIdentityCredentialID 

func NewFederatedIdentityCredentialID(subscriptionId string, resourceGroupName string, userAssignedIdentityName string, federatedIdentityCredentialName string) FederatedIdentityCredentialId

NewFederatedIdentityCredentialID returns a new FederatedIdentityCredentialId struct

func ParseFederatedIdentityCredentialID 

func ParseFederatedIdentityCredentialID(input string) (*FederatedIdentityCredentialId, error)

ParseFederatedIdentityCredentialID parses 'input' into a FederatedIdentityCredentialId

func ParseFederatedIdentityCredentialIDInsensitively 

func ParseFederatedIdentityCredentialIDInsensitively(input string) (*FederatedIdentityCredentialId, error)

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

func (*FederatedIdentityCredentialId) FromParseResult 

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

func (FederatedIdentityCredentialId) ID 

func (id FederatedIdentityCredentialId) ID() string

ID returns the formatted Federated Identity Credential ID

func (FederatedIdentityCredentialId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Federated Identity Credential ID

func (FederatedIdentityCredentialId) String 

func (id FederatedIdentityCredentialId) String() string

String returns a human-readable description of this Federated Identity Credential ID

type FederatedIdentityCredentialOperationPredicate 

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

func (FederatedIdentityCredentialOperationPredicate) Matches 

func (p FederatedIdentityCredentialOperationPredicate) Matches(input FederatedIdentityCredential) bool

type FederatedIdentityCredentialProperties 

type FederatedIdentityCredentialProperties struct {
	Audiences []string `json:"audiences"`
	Issuer    string   `json:"issuer"`
	Subject   string   `json:"subject"`
}

type FederatedIdentityCredentialsCreateOrUpdateOperationResponse 

type FederatedIdentityCredentialsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FederatedIdentityCredential
}

type FederatedIdentityCredentialsDeleteOperationResponse 

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

type FederatedIdentityCredentialsGetOperationResponse 

type FederatedIdentityCredentialsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FederatedIdentityCredential
}

type FederatedIdentityCredentialsListCompleteResult 

type FederatedIdentityCredentialsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []FederatedIdentityCredential
}

type FederatedIdentityCredentialsListCustomPager added in v0.20240628.1153531 

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

type FederatedIdentityCredentialsListOperationOptions 

type FederatedIdentityCredentialsListOperationOptions struct {
	Top *int64
}

func DefaultFederatedIdentityCredentialsListOperationOptions 

func DefaultFederatedIdentityCredentialsListOperationOptions() FederatedIdentityCredentialsListOperationOptions

func (FederatedIdentityCredentialsListOperationOptions) ToHeaders 

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

func (FederatedIdentityCredentialsListOperationOptions) ToOData 

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

func (FederatedIdentityCredentialsListOperationOptions) ToQuery 

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

type FederatedIdentityCredentialsListOperationResponse 

type FederatedIdentityCredentialsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]FederatedIdentityCredential
}

type Identity 

type Identity struct {
	Id         *string                         `json:"id,omitempty"`
	Location   string                          `json:"location"`
	Name       *string                         `json:"name,omitempty"`
	Properties *UserAssignedIdentityProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type IdentityOperationPredicate 

type IdentityOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (IdentityOperationPredicate) Matches 

func (p IdentityOperationPredicate) Matches(input Identity) bool

type IdentityUpdate 

type IdentityUpdate struct {
	Id         *string                         `json:"id,omitempty"`
	Location   *string                         `json:"location,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *UserAssignedIdentityProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type ManagedIdentitiesClient 

type ManagedIdentitiesClient struct {
	Client *resourcemanager.Client
}

func NewManagedIdentitiesClientWithBaseURI 

func NewManagedIdentitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedIdentitiesClient, error)

func (ManagedIdentitiesClient) FederatedIdentityCredentialsCreateOrUpdate 

func (c ManagedIdentitiesClient) FederatedIdentityCredentialsCreateOrUpdate(ctx context.Context, id FederatedIdentityCredentialId, input FederatedIdentityCredential) (result FederatedIdentityCredentialsCreateOrUpdateOperationResponse, err error)

FederatedIdentityCredentialsCreateOrUpdate ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsDelete 

func (c ManagedIdentitiesClient) FederatedIdentityCredentialsDelete(ctx context.Context, id FederatedIdentityCredentialId) (result FederatedIdentityCredentialsDeleteOperationResponse, err error)

FederatedIdentityCredentialsDelete ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsGet 

func (c ManagedIdentitiesClient) FederatedIdentityCredentialsGet(ctx context.Context, id FederatedIdentityCredentialId) (result FederatedIdentityCredentialsGetOperationResponse, err error)

FederatedIdentityCredentialsGet ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsList 

func (c ManagedIdentitiesClient) FederatedIdentityCredentialsList(ctx context.Context, id commonids.UserAssignedIdentityId, options FederatedIdentityCredentialsListOperationOptions) (result FederatedIdentityCredentialsListOperationResponse, err error)

FederatedIdentityCredentialsList ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsListComplete 

func (c ManagedIdentitiesClient) FederatedIdentityCredentialsListComplete(ctx context.Context, id commonids.UserAssignedIdentityId, options FederatedIdentityCredentialsListOperationOptions) (FederatedIdentityCredentialsListCompleteResult, error)

FederatedIdentityCredentialsListComplete retrieves all the results into a single object

func (ManagedIdentitiesClient) FederatedIdentityCredentialsListCompleteMatchingPredicate 

func (c ManagedIdentitiesClient) FederatedIdentityCredentialsListCompleteMatchingPredicate(ctx context.Context, id commonids.UserAssignedIdentityId, options FederatedIdentityCredentialsListOperationOptions, predicate FederatedIdentityCredentialOperationPredicate) (result FederatedIdentityCredentialsListCompleteResult, err error)

FederatedIdentityCredentialsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedIdentitiesClient) SystemAssignedIdentitiesGetByScope 

func (c ManagedIdentitiesClient) SystemAssignedIdentitiesGetByScope(ctx context.Context, id commonids.ScopeId) (result SystemAssignedIdentitiesGetByScopeOperationResponse, err error)

SystemAssignedIdentitiesGetByScope ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesCreateOrUpdate 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesCreateOrUpdate(ctx context.Context, id commonids.UserAssignedIdentityId, input Identity) (result UserAssignedIdentitiesCreateOrUpdateOperationResponse, err error)

UserAssignedIdentitiesCreateOrUpdate ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesDelete 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesDelete(ctx context.Context, id commonids.UserAssignedIdentityId) (result UserAssignedIdentitiesDeleteOperationResponse, err error)

UserAssignedIdentitiesDelete ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesGet 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesGet(ctx context.Context, id commonids.UserAssignedIdentityId) (result UserAssignedIdentitiesGetOperationResponse, err error)

UserAssignedIdentitiesGet ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroup 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result UserAssignedIdentitiesListByResourceGroupOperationResponse, err error)

UserAssignedIdentitiesListByResourceGroup ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroupComplete 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (UserAssignedIdentitiesListByResourceGroupCompleteResult, error)

UserAssignedIdentitiesListByResourceGroupComplete retrieves all the results into a single object

func (ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroupCompleteMatchingPredicate 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate IdentityOperationPredicate) (result UserAssignedIdentitiesListByResourceGroupCompleteResult, err error)

UserAssignedIdentitiesListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscription 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result UserAssignedIdentitiesListBySubscriptionOperationResponse, err error)

UserAssignedIdentitiesListBySubscription ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscriptionComplete 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (UserAssignedIdentitiesListBySubscriptionCompleteResult, error)

UserAssignedIdentitiesListBySubscriptionComplete retrieves all the results into a single object

func (ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscriptionCompleteMatchingPredicate 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate IdentityOperationPredicate) (result UserAssignedIdentitiesListBySubscriptionCompleteResult, err error)

UserAssignedIdentitiesListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedIdentitiesClient) UserAssignedIdentitiesUpdate 

func (c ManagedIdentitiesClient) UserAssignedIdentitiesUpdate(ctx context.Context, id commonids.UserAssignedIdentityId, input IdentityUpdate) (result UserAssignedIdentitiesUpdateOperationResponse, err error)

UserAssignedIdentitiesUpdate ...

type SystemAssignedIdentitiesGetByScopeOperationResponse 

type SystemAssignedIdentitiesGetByScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SystemAssignedIdentity
}

type SystemAssignedIdentity 

type SystemAssignedIdentity struct {
	Id         *string                           `json:"id,omitempty"`
	Location   string                            `json:"location"`
	Name       *string                           `json:"name,omitempty"`
	Properties *SystemAssignedIdentityProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData            `json:"systemData,omitempty"`
	Tags       *map[string]string                `json:"tags,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type SystemAssignedIdentityProperties 

type SystemAssignedIdentityProperties struct {
	ClientId        *string `json:"clientId,omitempty"`
	ClientSecretUrl *string `json:"clientSecretUrl,omitempty"`
	PrincipalId     *string `json:"principalId,omitempty"`
	TenantId        *string `json:"tenantId,omitempty"`
}

type UserAssignedIdentitiesCreateOrUpdateOperationResponse 

type UserAssignedIdentitiesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Identity
}

type UserAssignedIdentitiesDeleteOperationResponse 

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

type UserAssignedIdentitiesGetOperationResponse 

type UserAssignedIdentitiesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Identity
}

type UserAssignedIdentitiesListByResourceGroupCompleteResult 

type UserAssignedIdentitiesListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Identity
}

type UserAssignedIdentitiesListByResourceGroupCustomPager added in v0.20240628.1153531 

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

type UserAssignedIdentitiesListByResourceGroupOperationResponse 

type UserAssignedIdentitiesListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Identity
}

type UserAssignedIdentitiesListBySubscriptionCompleteResult 

type UserAssignedIdentitiesListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Identity
}

type UserAssignedIdentitiesListBySubscriptionCustomPager added in v0.20240628.1153531 

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

type UserAssignedIdentitiesListBySubscriptionOperationResponse 

type UserAssignedIdentitiesListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Identity
}

type UserAssignedIdentitiesUpdateOperationResponse 

type UserAssignedIdentitiesUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Identity
}

type UserAssignedIdentityProperties 

type UserAssignedIdentityProperties struct {
	ClientId    *string `json:"clientId,omitempty"`
	PrincipalId *string `json:"principalId,omitempty"`
	TenantId    *string `json:"tenantId,omitempty"`
}

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.