msi

package
v36.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package msi implements the Azure ARM Msi service API version 2018-11-30.

The Managed Service Identity Client.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Msi
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Msi.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CloudError 

type CloudError struct {
	// Error - A list of additional details about the error.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from the ManagedServiceIdentity service.

type CloudErrorBody 

type CloudErrorBody struct {
	// Code - An identifier for the error.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from the ManagedServiceIdentity service.

type Identity 

type Identity struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The id of the created identity.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the created identity.
	Name *string `json:"name,omitempty"`
	// Location - The Azure region where the identity lives.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// IdentityProperties - The properties associated with the identity.
	*IdentityProperties `json:"properties,omitempty"`
	// Type - READ-ONLY; The type of resource i.e. Microsoft.ManagedIdentity/userAssignedIdentities. Possible values include: 'MicrosoftManagedIdentityuserAssignedIdentities'
	Type UserAssignedIdentities `json:"type,omitempty"`
}

Identity describes an identity resource.

func (Identity) MarshalJSON 

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Identity.

func (*Identity) UnmarshalJSON 

func (i *Identity) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Identity struct.

type IdentityProperties 

type IdentityProperties struct {
	// TenantID - READ-ONLY; The id of the tenant which the identity belongs to.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// PrincipalID - READ-ONLY; The id of the service principal object associated with the created identity.
	PrincipalID *uuid.UUID `json:"principalId,omitempty"`
	// ClientID - READ-ONLY; The id of the app associated with the identity. This is a random generated UUID by MSI.
	ClientID *uuid.UUID `json:"clientId,omitempty"`
	// ClientSecretURL - READ-ONLY;  The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials. If identity is user assigned, then the clientSecretUrl will not be present in the response, otherwise it will be present.
	ClientSecretURL *string `json:"clientSecretUrl,omitempty"`
}

IdentityProperties the properties associated with the identity.

type Operation 

type Operation struct {
	// Name - The name of the REST Operation. This is of the format {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The object that describes the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation operation supported by the Microsoft.ManagedIdentity REST API.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Friendly name of the resource provider.
	Provider *string `json:"provider,omitempty"`
	// Operation - The type of operation. For example: read, write, delete.
	Operation *string `json:"operation,omitempty"`
	// Resource - The resource type on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Description - A description of the operation.
	Description *string `json:"description,omitempty"`
}

OperationDisplay the object that describes the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - A list of operations supported by Microsoft.ManagedIdentity Resource Provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - The url to get the next page of results, if any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult a list of operations supported by Microsoft.ManagedIdentity Resource Provider.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

type OperationListResultIterator struct {
	// contains filtered or unexported fields
}

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage 

type OperationListResultPage struct {
	// contains filtered or unexported fields
}

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the the Managed Service Identity Client.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists available operations for the Microsoft.ManagedIdentity provider

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UserAssignedIdentities 

type UserAssignedIdentities string

UserAssignedIdentities enumerates the values for user assigned identities. 

const (
	// MicrosoftManagedIdentityuserAssignedIdentities ...
	MicrosoftManagedIdentityuserAssignedIdentities UserAssignedIdentities = "Microsoft.ManagedIdentity/userAssignedIdentities"
)

func PossibleUserAssignedIdentitiesValues 

func PossibleUserAssignedIdentitiesValues() []UserAssignedIdentities

PossibleUserAssignedIdentitiesValues returns an array of possible values for the UserAssignedIdentities const type.

type UserAssignedIdentitiesClient 

type UserAssignedIdentitiesClient struct {
	BaseClient
}

UserAssignedIdentitiesClient is the the Managed Service Identity Client.

func NewUserAssignedIdentitiesClient 

func NewUserAssignedIdentitiesClient(subscriptionID string) UserAssignedIdentitiesClient

NewUserAssignedIdentitiesClient creates an instance of the UserAssignedIdentitiesClient client.

func NewUserAssignedIdentitiesClientWithBaseURI 

func NewUserAssignedIdentitiesClientWithBaseURI(baseURI string, subscriptionID string) UserAssignedIdentitiesClient

NewUserAssignedIdentitiesClientWithBaseURI creates an instance of the UserAssignedIdentitiesClient client.

func (UserAssignedIdentitiesClient) CreateOrUpdate 

func (client UserAssignedIdentitiesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, parameters Identity) (result Identity, err error)

CreateOrUpdate create or update an identity in the specified subscription and resource group. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs. resourceName - the name of the identity resource. parameters - parameters to create or update the identity

func (UserAssignedIdentitiesClient) CreateOrUpdatePreparer 

func (client UserAssignedIdentitiesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters Identity) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (UserAssignedIdentitiesClient) CreateOrUpdateResponder 

func (client UserAssignedIdentitiesClient) CreateOrUpdateResponder(resp *http.Response) (result Identity, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (UserAssignedIdentitiesClient) CreateOrUpdateSender 

func (client UserAssignedIdentitiesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (UserAssignedIdentitiesClient) Delete 

func (client UserAssignedIdentitiesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result autorest.Response, err error)

Delete deletes the identity. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs. resourceName - the name of the identity resource.

func (UserAssignedIdentitiesClient) DeletePreparer 

func (client UserAssignedIdentitiesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (UserAssignedIdentitiesClient) DeleteResponder 

func (client UserAssignedIdentitiesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (UserAssignedIdentitiesClient) DeleteSender 

func (client UserAssignedIdentitiesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (UserAssignedIdentitiesClient) Get 

func (client UserAssignedIdentitiesClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result Identity, err error)

Get gets the identity. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs. resourceName - the name of the identity resource.

func (UserAssignedIdentitiesClient) GetPreparer 

func (client UserAssignedIdentitiesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UserAssignedIdentitiesClient) GetResponder 

func (client UserAssignedIdentitiesClient) GetResponder(resp *http.Response) (result Identity, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (UserAssignedIdentitiesClient) GetSender 

func (client UserAssignedIdentitiesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (UserAssignedIdentitiesClient) ListByResourceGroup 

func (client UserAssignedIdentitiesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result UserAssignedIdentitiesListResultPage, err error)

ListByResourceGroup lists all the userAssignedIdentities available under the specified ResourceGroup. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs.

func (UserAssignedIdentitiesClient) ListByResourceGroupComplete 

func (client UserAssignedIdentitiesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result UserAssignedIdentitiesListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (UserAssignedIdentitiesClient) ListByResourceGroupPreparer 

func (client UserAssignedIdentitiesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (UserAssignedIdentitiesClient) ListByResourceGroupResponder 

func (client UserAssignedIdentitiesClient) ListByResourceGroupResponder(resp *http.Response) (result UserAssignedIdentitiesListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (UserAssignedIdentitiesClient) ListByResourceGroupSender 

func (client UserAssignedIdentitiesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (UserAssignedIdentitiesClient) ListBySubscription 

func (client UserAssignedIdentitiesClient) ListBySubscription(ctx context.Context) (result UserAssignedIdentitiesListResultPage, err error)

ListBySubscription lists all the userAssignedIdentities available under the specified subscription.

func (UserAssignedIdentitiesClient) ListBySubscriptionComplete 

func (client UserAssignedIdentitiesClient) ListBySubscriptionComplete(ctx context.Context) (result UserAssignedIdentitiesListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (UserAssignedIdentitiesClient) ListBySubscriptionPreparer 

func (client UserAssignedIdentitiesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (UserAssignedIdentitiesClient) ListBySubscriptionResponder 

func (client UserAssignedIdentitiesClient) ListBySubscriptionResponder(resp *http.Response) (result UserAssignedIdentitiesListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (UserAssignedIdentitiesClient) ListBySubscriptionSender 

func (client UserAssignedIdentitiesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (UserAssignedIdentitiesClient) Update 

func (client UserAssignedIdentitiesClient) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters Identity) (result Identity, err error)

Update update an identity in the specified subscription and resource group. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs. resourceName - the name of the identity resource. parameters - parameters to update the identity

func (UserAssignedIdentitiesClient) UpdatePreparer 

func (client UserAssignedIdentitiesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters Identity) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (UserAssignedIdentitiesClient) UpdateResponder 

func (client UserAssignedIdentitiesClient) UpdateResponder(resp *http.Response) (result Identity, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (UserAssignedIdentitiesClient) UpdateSender 

func (client UserAssignedIdentitiesClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type UserAssignedIdentitiesListResult 

type UserAssignedIdentitiesListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of userAssignedIdentities returned by the listing operation.
	Value *[]Identity `json:"value,omitempty"`
	// NextLink - The url to get the next page of results, if any.
	NextLink *string `json:"nextLink,omitempty"`
}

UserAssignedIdentitiesListResult values returned by the List operation.

func (UserAssignedIdentitiesListResult) IsEmpty 

func (uailr UserAssignedIdentitiesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UserAssignedIdentitiesListResultIterator 

type UserAssignedIdentitiesListResultIterator struct {
	// contains filtered or unexported fields
}

UserAssignedIdentitiesListResultIterator provides access to a complete listing of Identity values.

func NewUserAssignedIdentitiesListResultIterator 

func NewUserAssignedIdentitiesListResultIterator(page UserAssignedIdentitiesListResultPage) UserAssignedIdentitiesListResultIterator

Creates a new instance of the UserAssignedIdentitiesListResultIterator type.

func (*UserAssignedIdentitiesListResultIterator) Next 

func (iter *UserAssignedIdentitiesListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*UserAssignedIdentitiesListResultIterator) NextWithContext 

func (iter *UserAssignedIdentitiesListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (UserAssignedIdentitiesListResultIterator) NotDone 

func (iter UserAssignedIdentitiesListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (UserAssignedIdentitiesListResultIterator) Response 

func (iter UserAssignedIdentitiesListResultIterator) Response() UserAssignedIdentitiesListResult

Response returns the raw server response from the last page request.

func (UserAssignedIdentitiesListResultIterator) Value 

func (iter UserAssignedIdentitiesListResultIterator) Value() Identity

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type UserAssignedIdentitiesListResultPage 

type UserAssignedIdentitiesListResultPage struct {
	// contains filtered or unexported fields
}

UserAssignedIdentitiesListResultPage contains a page of Identity values.

func NewUserAssignedIdentitiesListResultPage 

func NewUserAssignedIdentitiesListResultPage(getNextPage func(context.Context, UserAssignedIdentitiesListResult) (UserAssignedIdentitiesListResult, error)) UserAssignedIdentitiesListResultPage

Creates a new instance of the UserAssignedIdentitiesListResultPage type.

func (*UserAssignedIdentitiesListResultPage) Next 

func (page *UserAssignedIdentitiesListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*UserAssignedIdentitiesListResultPage) NextWithContext 

func (page *UserAssignedIdentitiesListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (UserAssignedIdentitiesListResultPage) NotDone 

func (page UserAssignedIdentitiesListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (UserAssignedIdentitiesListResultPage) Response 

func (page UserAssignedIdentitiesListResultPage) Response() UserAssignedIdentitiesListResult

Response returns the raw server response from the last page request.

func (UserAssignedIdentitiesListResultPage) Values 

func (page UserAssignedIdentitiesListResultPage) Values() []Identity

Values returns the slice of values for the current page or nil if there are no values.

Source Files

View all Source files

Directories

Path Synopsis

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.