managedidentities

package
v0.20230306.1165107 Latest Latest
Warning

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

Go to latest
Published: Mar 6, 2023 License: MPL-2.0 Imports: 9 Imported by: 0

README

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

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

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/managedidentity/2022-01-31-preview/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 := managedidentities.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 := managedidentities.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 := managedidentities.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 := managedidentities.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 := managedidentities.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.UserAssignedIdentitiesListAssociatedResources

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

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

Example Usage: ManagedIdentitiesClient.UserAssignedIdentitiesListByResourceGroup

ctx := context.TODO()
id := managedidentities.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 := managedidentities.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 := managedidentities.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 AzureResource

type AzureResource struct {
	Id                      *string `json:"id,omitempty"`
	Name                    *string `json:"name,omitempty"`
	ResourceGroup           *string `json:"resourceGroup,omitempty"`
	SubscriptionDisplayName *string `json:"subscriptionDisplayName,omitempty"`
	SubscriptionId          *string `json:"subscriptionId,omitempty"`
	Type                    *string `json:"type,omitempty"`
}

type AzureResourceOperationPredicate

type AzureResourceOperationPredicate struct {
	Id                      *string
	Name                    *string
	ResourceGroup           *string
	SubscriptionDisplayName *string
	SubscriptionId          *string
	Type                    *string
}

func (AzureResourceOperationPredicate) Matches

type FederatedIdentityCredential

type FederatedIdentityCredential struct {
	Id         *string                                `json:"id,omitempty"`
	Name       *string                                `json:"name,omitempty"`
	Properties *FederatedIdentityCredentialProperties `json:"properties,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) ID

ID returns the formatted Federated Identity Credential ID

func (FederatedIdentityCredentialId) Segments

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

func (FederatedIdentityCredentialId) 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

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
	Model        *FederatedIdentityCredential
}

type FederatedIdentityCredentialsDeleteOperationResponse

type FederatedIdentityCredentialsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type FederatedIdentityCredentialsGetOperationResponse

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

type FederatedIdentityCredentialsListCompleteResult

type FederatedIdentityCredentialsListCompleteResult struct {
	Items []FederatedIdentityCredential
}

type FederatedIdentityCredentialsListOperationOptions

type FederatedIdentityCredentialsListOperationOptions struct {
	Top *int64
}

func DefaultFederatedIdentityCredentialsListOperationOptions

func DefaultFederatedIdentityCredentialsListOperationOptions() FederatedIdentityCredentialsListOperationOptions

type FederatedIdentityCredentialsListOperationResponse

type FederatedIdentityCredentialsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]FederatedIdentityCredential
	// contains filtered or unexported fields
}

func (FederatedIdentityCredentialsListOperationResponse) HasMore

func (FederatedIdentityCredentialsListOperationResponse) LoadMore

type Identity

type Identity struct {
	Id         *string                         `json:"id,omitempty"`
	Location   string                          `json:"location"`
	Name       *string                         `json:"name,omitempty"`
	Properties *UserAssignedIdentityProperties `json:"properties,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"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type ManagedIdentitiesClient

type ManagedIdentitiesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewManagedIdentitiesClientWithBaseURI

func NewManagedIdentitiesClientWithBaseURI(endpoint string) ManagedIdentitiesClient

func (ManagedIdentitiesClient) FederatedIdentityCredentialsCreateOrUpdate

FederatedIdentityCredentialsCreateOrUpdate ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsDelete

FederatedIdentityCredentialsDelete ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsGet

FederatedIdentityCredentialsGet ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsList

FederatedIdentityCredentialsList ...

func (ManagedIdentitiesClient) FederatedIdentityCredentialsListComplete

FederatedIdentityCredentialsListComplete retrieves all of the results into a single object

func (ManagedIdentitiesClient) FederatedIdentityCredentialsListCompleteMatchingPredicate

FederatedIdentityCredentialsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedIdentitiesClient) SystemAssignedIdentitiesGetByScope

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

SystemAssignedIdentitiesGetByScope ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesCreateOrUpdate

UserAssignedIdentitiesCreateOrUpdate ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesDelete

UserAssignedIdentitiesDelete ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesGet

UserAssignedIdentitiesGet ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesListAssociatedResources

UserAssignedIdentitiesListAssociatedResources ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesListAssociatedResourcesComplete

UserAssignedIdentitiesListAssociatedResourcesComplete retrieves all of the results into a single object

func (ManagedIdentitiesClient) UserAssignedIdentitiesListAssociatedResourcesCompleteMatchingPredicate

UserAssignedIdentitiesListAssociatedResourcesCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroup

UserAssignedIdentitiesListByResourceGroup ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroupComplete

UserAssignedIdentitiesListByResourceGroupComplete retrieves all of the results into a single object

func (ManagedIdentitiesClient) UserAssignedIdentitiesListByResourceGroupCompleteMatchingPredicate

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

UserAssignedIdentitiesListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscription

UserAssignedIdentitiesListBySubscription ...

func (ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscriptionComplete

UserAssignedIdentitiesListBySubscriptionComplete retrieves all of the results into a single object

func (ManagedIdentitiesClient) UserAssignedIdentitiesListBySubscriptionCompleteMatchingPredicate

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

UserAssignedIdentitiesListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedIdentitiesClient) UserAssignedIdentitiesUpdate

UserAssignedIdentitiesUpdate ...

type SystemAssignedIdentitiesGetByScopeOperationResponse

type SystemAssignedIdentitiesGetByScopeOperationResponse struct {
	HttpResponse *http.Response
	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"`
	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
	Model        *Identity
}

type UserAssignedIdentitiesDeleteOperationResponse

type UserAssignedIdentitiesDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type UserAssignedIdentitiesGetOperationResponse

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

type UserAssignedIdentitiesListAssociatedResourcesCompleteResult

type UserAssignedIdentitiesListAssociatedResourcesCompleteResult struct {
	Items []AzureResource
}

type UserAssignedIdentitiesListAssociatedResourcesOperationOptions

type UserAssignedIdentitiesListAssociatedResourcesOperationOptions struct {
	Filter  *string
	Orderby *string
	Skip    *int64
	Top     *int64
}

type UserAssignedIdentitiesListAssociatedResourcesOperationResponse

type UserAssignedIdentitiesListAssociatedResourcesOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]AzureResource
	// contains filtered or unexported fields
}

func (UserAssignedIdentitiesListAssociatedResourcesOperationResponse) HasMore

func (UserAssignedIdentitiesListAssociatedResourcesOperationResponse) LoadMore

type UserAssignedIdentitiesListByResourceGroupCompleteResult

type UserAssignedIdentitiesListByResourceGroupCompleteResult struct {
	Items []Identity
}

type UserAssignedIdentitiesListByResourceGroupOperationResponse

type UserAssignedIdentitiesListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Identity
	// contains filtered or unexported fields
}

func (UserAssignedIdentitiesListByResourceGroupOperationResponse) HasMore

func (UserAssignedIdentitiesListByResourceGroupOperationResponse) LoadMore

type UserAssignedIdentitiesListBySubscriptionCompleteResult

type UserAssignedIdentitiesListBySubscriptionCompleteResult struct {
	Items []Identity
}

type UserAssignedIdentitiesListBySubscriptionOperationResponse

type UserAssignedIdentitiesListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Identity
	// contains filtered or unexported fields
}

func (UserAssignedIdentitiesListBySubscriptionOperationResponse) HasMore

func (UserAssignedIdentitiesListBySubscriptionOperationResponse) LoadMore

type UserAssignedIdentitiesUpdateOperationResponse

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

type UserAssignedIdentityProperties

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL