msi

package
v67.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Jan 10, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/msi/armmsi(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/msi/armmsi). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package msi implements the Azure ARM Msi service API version 2022-01-31-preview.

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 AssociatedResourcesListResult

type AssociatedResourcesListResult struct {
	autorest.Response `json:"-"`
	// TotalCount - READ-ONLY; Total number of Azure resources assigned to the identity.
	TotalCount *float64 `json:"totalCount,omitempty"`
	// Value - READ-ONLY; The collection of Azure resources returned by the resource action to get a list of assigned resources.
	Value *[]AzureResource `json:"value,omitempty"`
	// NextLink - READ-ONLY; The url to get the next page of results, if any.
	NextLink *string `json:"nextLink,omitempty"`
}

AssociatedResourcesListResult azure resources returned by the resource action to get a list of assigned resources.

func (AssociatedResourcesListResult) IsEmpty

func (arlr AssociatedResourcesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (AssociatedResourcesListResult) MarshalJSON

func (arlr AssociatedResourcesListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssociatedResourcesListResult.

type AssociatedResourcesListResultIterator

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

AssociatedResourcesListResultIterator provides access to a complete listing of AzureResource values.

func NewAssociatedResourcesListResultIterator

func NewAssociatedResourcesListResultIterator(page AssociatedResourcesListResultPage) AssociatedResourcesListResultIterator

Creates a new instance of the AssociatedResourcesListResultIterator type.

func (*AssociatedResourcesListResultIterator) Next

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 (*AssociatedResourcesListResultIterator) NextWithContext

func (iter *AssociatedResourcesListResultIterator) 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 (AssociatedResourcesListResultIterator) NotDone

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

func (AssociatedResourcesListResultIterator) Response

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

func (AssociatedResourcesListResultIterator) Value

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

type AssociatedResourcesListResultPage

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

AssociatedResourcesListResultPage contains a page of AzureResource values.

func NewAssociatedResourcesListResultPage

Creates a new instance of the AssociatedResourcesListResultPage type.

func (*AssociatedResourcesListResultPage) Next

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 (*AssociatedResourcesListResultPage) NextWithContext

func (page *AssociatedResourcesListResultPage) 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 (AssociatedResourcesListResultPage) NotDone

func (page AssociatedResourcesListResultPage) NotDone() bool

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

func (AssociatedResourcesListResultPage) Response

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

func (AssociatedResourcesListResultPage) Values

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

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type AzureResource

type AzureResource struct {
	// ID - READ-ONLY; The ID of this resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of this resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of this resource.
	Type *string `json:"type,omitempty"`
	// ResourceGroup - READ-ONLY; The name of the resource group this resource belongs to.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
	// SubscriptionID - READ-ONLY; The ID of the subscription this resource belongs to.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// SubscriptionDisplayName - READ-ONLY; The name of the subscription this resource belongs to.
	SubscriptionDisplayName *string `json:"subscriptionDisplayName,omitempty"`
}

AzureResource describes an Azure resource that is attached to an identity.

func (AzureResource) MarshalJSON

func (ar AzureResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureResource.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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 FederatedIdentityCredential

type FederatedIdentityCredential struct {
	autorest.Response `json:"-"`
	// FederatedIdentityCredentialProperties - The properties associated with the federated identity credential.
	*FederatedIdentityCredentialProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

FederatedIdentityCredential describes a federated identity credential.

func (FederatedIdentityCredential) MarshalJSON

func (fic FederatedIdentityCredential) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FederatedIdentityCredential.

func (*FederatedIdentityCredential) UnmarshalJSON

func (fic *FederatedIdentityCredential) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FederatedIdentityCredential struct.

type FederatedIdentityCredentialProperties

type FederatedIdentityCredentialProperties struct {
	// Issuer - The URL of the issuer to be trusted.
	Issuer *string `json:"issuer,omitempty"`
	// Subject - The identifier of the external identity.
	Subject *string `json:"subject,omitempty"`
	// Audiences - The list of audiences that can appear in the issued token.
	Audiences *[]string `json:"audiences,omitempty"`
}

FederatedIdentityCredentialProperties the properties associated with a federated identity credential.

type FederatedIdentityCredentialsClient

type FederatedIdentityCredentialsClient struct {
	BaseClient
}

FederatedIdentityCredentialsClient is the the Managed Service Identity Client.

func NewFederatedIdentityCredentialsClient

func NewFederatedIdentityCredentialsClient(subscriptionID string) FederatedIdentityCredentialsClient

NewFederatedIdentityCredentialsClient creates an instance of the FederatedIdentityCredentialsClient client.

func NewFederatedIdentityCredentialsClientWithBaseURI

func NewFederatedIdentityCredentialsClientWithBaseURI(baseURI string, subscriptionID string) FederatedIdentityCredentialsClient

NewFederatedIdentityCredentialsClientWithBaseURI creates an instance of the FederatedIdentityCredentialsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (FederatedIdentityCredentialsClient) CreateOrUpdate

func (client FederatedIdentityCredentialsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, federatedIdentityCredentialResourceName string, parameters FederatedIdentityCredential) (result FederatedIdentityCredential, err error)

CreateOrUpdate create or update a federated identity credential under the specified user assigned identity. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs. resourceName - the name of the identity resource. federatedIdentityCredentialResourceName - the name of the federated identity credential resource. parameters - parameters to create or update the federated identity credential.

func (FederatedIdentityCredentialsClient) CreateOrUpdatePreparer

func (client FederatedIdentityCredentialsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, federatedIdentityCredentialResourceName string, parameters FederatedIdentityCredential) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (FederatedIdentityCredentialsClient) CreateOrUpdateResponder

func (client FederatedIdentityCredentialsClient) CreateOrUpdateResponder(resp *http.Response) (result FederatedIdentityCredential, err error)

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

func (FederatedIdentityCredentialsClient) CreateOrUpdateSender

func (client FederatedIdentityCredentialsClient) 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 (FederatedIdentityCredentialsClient) Delete

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

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

func (FederatedIdentityCredentialsClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (FederatedIdentityCredentialsClient) DeleteResponder

func (client FederatedIdentityCredentialsClient) 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 (FederatedIdentityCredentialsClient) DeleteSender

func (client FederatedIdentityCredentialsClient) 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 (FederatedIdentityCredentialsClient) Get

func (client FederatedIdentityCredentialsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, federatedIdentityCredentialResourceName string) (result FederatedIdentityCredential, err error)

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

func (FederatedIdentityCredentialsClient) GetPreparer

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

GetPreparer prepares the Get request.

func (FederatedIdentityCredentialsClient) GetResponder

func (client FederatedIdentityCredentialsClient) GetResponder(resp *http.Response) (result FederatedIdentityCredential, err error)

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

func (FederatedIdentityCredentialsClient) GetSender

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

func (FederatedIdentityCredentialsClient) List

func (client FederatedIdentityCredentialsClient) List(ctx context.Context, resourceGroupName string, resourceName string, top *int32, skiptoken string) (result FederatedIdentityCredentialsListResultPage, err error)

List lists all the federated identity credentials under the specified user assigned identity. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs. resourceName - the name of the identity resource. top - number of records to return. skiptoken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (FederatedIdentityCredentialsClient) ListComplete

func (client FederatedIdentityCredentialsClient) ListComplete(ctx context.Context, resourceGroupName string, resourceName string, top *int32, skiptoken string) (result FederatedIdentityCredentialsListResultIterator, err error)

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

func (FederatedIdentityCredentialsClient) ListPreparer

func (client FederatedIdentityCredentialsClient) ListPreparer(ctx context.Context, resourceGroupName string, resourceName string, top *int32, skiptoken string) (*http.Request, error)

ListPreparer prepares the List request.

func (FederatedIdentityCredentialsClient) ListResponder

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

func (FederatedIdentityCredentialsClient) ListSender

func (client FederatedIdentityCredentialsClient) 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 FederatedIdentityCredentialsListResult

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

FederatedIdentityCredentialsListResult values returned by the List operation for federated identity credentials.

func (FederatedIdentityCredentialsListResult) IsEmpty

IsEmpty returns true if the ListResult contains no values.

type FederatedIdentityCredentialsListResultIterator

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

FederatedIdentityCredentialsListResultIterator provides access to a complete listing of FederatedIdentityCredential values.

func NewFederatedIdentityCredentialsListResultIterator

func NewFederatedIdentityCredentialsListResultIterator(page FederatedIdentityCredentialsListResultPage) FederatedIdentityCredentialsListResultIterator

Creates a new instance of the FederatedIdentityCredentialsListResultIterator type.

func (*FederatedIdentityCredentialsListResultIterator) Next

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 (*FederatedIdentityCredentialsListResultIterator) NextWithContext

func (iter *FederatedIdentityCredentialsListResultIterator) 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 (FederatedIdentityCredentialsListResultIterator) NotDone

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

func (FederatedIdentityCredentialsListResultIterator) Response

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

func (FederatedIdentityCredentialsListResultIterator) Value

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

type FederatedIdentityCredentialsListResultPage

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

FederatedIdentityCredentialsListResultPage contains a page of FederatedIdentityCredential values.

func NewFederatedIdentityCredentialsListResultPage

Creates a new instance of the FederatedIdentityCredentialsListResultPage type.

func (*FederatedIdentityCredentialsListResultPage) Next

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 (*FederatedIdentityCredentialsListResultPage) NextWithContext

func (page *FederatedIdentityCredentialsListResultPage) 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 (FederatedIdentityCredentialsListResultPage) NotDone

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

func (FederatedIdentityCredentialsListResultPage) Response

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

func (FederatedIdentityCredentialsListResultPage) Values

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

type Identity

type Identity struct {
	autorest.Response `json:"-"`
	// UserAssignedIdentityProperties - READ-ONLY; The properties associated with the identity.
	*UserAssignedIdentityProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `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 IdentityUpdate

type IdentityUpdate struct {
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// UserAssignedIdentityProperties - READ-ONLY; The properties associated with the identity.
	*UserAssignedIdentityProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

IdentityUpdate describes an identity resource.

func (IdentityUpdate) MarshalJSON

func (iu IdentityUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IdentityUpdate.

func (*IdentityUpdate) UnmarshalJSON

func (iu *IdentityUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IdentityUpdate struct.

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

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

func (OperationListResultIterator) Value

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(cur OperationListResult, 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

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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 ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type SystemAssignedIdentitiesClient

type SystemAssignedIdentitiesClient struct {
	BaseClient
}

SystemAssignedIdentitiesClient is the the Managed Service Identity Client.

func NewSystemAssignedIdentitiesClient

func NewSystemAssignedIdentitiesClient(subscriptionID string) SystemAssignedIdentitiesClient

NewSystemAssignedIdentitiesClient creates an instance of the SystemAssignedIdentitiesClient client.

func NewSystemAssignedIdentitiesClientWithBaseURI

func NewSystemAssignedIdentitiesClientWithBaseURI(baseURI string, subscriptionID string) SystemAssignedIdentitiesClient

NewSystemAssignedIdentitiesClientWithBaseURI creates an instance of the SystemAssignedIdentitiesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (SystemAssignedIdentitiesClient) GetByScope

func (client SystemAssignedIdentitiesClient) GetByScope(ctx context.Context, scope string) (result SystemAssignedIdentity, err error)

GetByScope gets the systemAssignedIdentity available under the specified RP scope. Parameters: scope - the resource provider scope of the resource. Parent resource being extended by Managed Identities.

func (SystemAssignedIdentitiesClient) GetByScopePreparer

func (client SystemAssignedIdentitiesClient) GetByScopePreparer(ctx context.Context, scope string) (*http.Request, error)

GetByScopePreparer prepares the GetByScope request.

func (SystemAssignedIdentitiesClient) GetByScopeResponder

func (client SystemAssignedIdentitiesClient) GetByScopeResponder(resp *http.Response) (result SystemAssignedIdentity, err error)

GetByScopeResponder handles the response to the GetByScope request. The method always closes the http.Response Body.

func (SystemAssignedIdentitiesClient) GetByScopeSender

func (client SystemAssignedIdentitiesClient) GetByScopeSender(req *http.Request) (*http.Response, error)

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

type SystemAssignedIdentity

type SystemAssignedIdentity struct {
	autorest.Response `json:"-"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// SystemAssignedIdentityProperties - READ-ONLY; The properties associated with the identity.
	*SystemAssignedIdentityProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

SystemAssignedIdentity describes a system assigned identity resource.

func (SystemAssignedIdentity) MarshalJSON

func (sai SystemAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SystemAssignedIdentity.

func (*SystemAssignedIdentity) UnmarshalJSON

func (sai *SystemAssignedIdentity) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SystemAssignedIdentity struct.

type SystemAssignedIdentityProperties

type SystemAssignedIdentityProperties 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.
	ClientSecretURL *string `json:"clientSecretUrl,omitempty"`
}

SystemAssignedIdentityProperties the properties associated with the system assigned identity.

func (SystemAssignedIdentityProperties) MarshalJSON

func (saip SystemAssignedIdentityProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SystemAssignedIdentityProperties.

type TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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) ListAssociatedResources

func (client UserAssignedIdentitiesClient) ListAssociatedResources(ctx context.Context, resourceGroupName string, resourceName string, filter string, orderby string, top *int32, skip *int32, skiptoken string) (result AssociatedResourcesListResultPage, err error)

ListAssociatedResources lists the associated resources for this identity. Parameters: resourceGroupName - the name of the Resource Group to which the identity belongs. resourceName - the name of the identity resource. filter - oData filter expression to apply to the query. orderby - oData orderBy expression to apply to the query. top - number of records to return. skip - number of records to skip. skiptoken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (UserAssignedIdentitiesClient) ListAssociatedResourcesComplete

func (client UserAssignedIdentitiesClient) ListAssociatedResourcesComplete(ctx context.Context, resourceGroupName string, resourceName string, filter string, orderby string, top *int32, skip *int32, skiptoken string) (result AssociatedResourcesListResultIterator, err error)

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

func (UserAssignedIdentitiesClient) ListAssociatedResourcesPreparer

func (client UserAssignedIdentitiesClient) ListAssociatedResourcesPreparer(ctx context.Context, resourceGroupName string, resourceName string, filter string, orderby string, top *int32, skip *int32, skiptoken string) (*http.Request, error)

ListAssociatedResourcesPreparer prepares the ListAssociatedResources request.

func (UserAssignedIdentitiesClient) ListAssociatedResourcesResponder

func (client UserAssignedIdentitiesClient) ListAssociatedResourcesResponder(resp *http.Response) (result AssociatedResourcesListResult, err error)

ListAssociatedResourcesResponder handles the response to the ListAssociatedResources request. The method always closes the http.Response Body.

func (UserAssignedIdentitiesClient) ListAssociatedResourcesSender

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

ListAssociatedResourcesSender sends the ListAssociatedResources 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 IdentityUpdate) (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 IdentityUpdate) (*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

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

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

func (UserAssignedIdentitiesListResultIterator) Response

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

func (UserAssignedIdentitiesListResultIterator) Value

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

Creates a new instance of the UserAssignedIdentitiesListResultPage type.

func (*UserAssignedIdentitiesListResultPage) Next

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

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

func (UserAssignedIdentitiesListResultPage) Response

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

func (UserAssignedIdentitiesListResultPage) Values

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

type UserAssignedIdentityProperties

type UserAssignedIdentityProperties 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"`
}

UserAssignedIdentityProperties the properties associated with the user assigned identity.

func (UserAssignedIdentityProperties) MarshalJSON

func (uaip UserAssignedIdentityProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserAssignedIdentityProperties.

Directories

Path Synopsis
Deprecated: Please note, this package has been deprecated.
Deprecated: Please note, this package has been deprecated.

Jump to

Keyboard shortcuts

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