Documentation ¶
Overview ¶
Package msi implements the Azure ARM Msi service API version 2018-11-30.
The Managed Service Identity Client.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AzureEntityResource
- type BaseClient
- type CloudError
- type CloudErrorBody
- type Identity
- type IdentityUpdate
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() Operation
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []Operation
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ProxyResource
- type Resource
- type SystemAssignedIdentitiesClient
- func (client SystemAssignedIdentitiesClient) GetByScope(ctx context.Context, scope string) (result SystemAssignedIdentity, err error)
- func (client SystemAssignedIdentitiesClient) GetByScopePreparer(ctx context.Context, scope string) (*http.Request, error)
- func (client SystemAssignedIdentitiesClient) GetByScopeResponder(resp *http.Response) (result SystemAssignedIdentity, err error)
- func (client SystemAssignedIdentitiesClient) GetByScopeSender(req *http.Request) (*http.Response, error)
- type SystemAssignedIdentity
- type SystemAssignedIdentityProperties
- type TrackedResource
- type UserAssignedIdentitiesClient
- func (client UserAssignedIdentitiesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, ...) (result Identity, err error)
- func (client UserAssignedIdentitiesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client UserAssignedIdentitiesClient) CreateOrUpdateResponder(resp *http.Response) (result Identity, err error)
- func (client UserAssignedIdentitiesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client UserAssignedIdentitiesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result autorest.Response, err error)
- func (client UserAssignedIdentitiesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client UserAssignedIdentitiesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client UserAssignedIdentitiesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client UserAssignedIdentitiesClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result Identity, err error)
- func (client UserAssignedIdentitiesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client UserAssignedIdentitiesClient) GetResponder(resp *http.Response) (result Identity, err error)
- func (client UserAssignedIdentitiesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client UserAssignedIdentitiesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result UserAssignedIdentitiesListResultPage, err error)
- func (client UserAssignedIdentitiesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result UserAssignedIdentitiesListResultIterator, err error)
- func (client UserAssignedIdentitiesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client UserAssignedIdentitiesClient) ListByResourceGroupResponder(resp *http.Response) (result UserAssignedIdentitiesListResult, err error)
- func (client UserAssignedIdentitiesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client UserAssignedIdentitiesClient) ListBySubscription(ctx context.Context) (result UserAssignedIdentitiesListResultPage, err error)
- func (client UserAssignedIdentitiesClient) ListBySubscriptionComplete(ctx context.Context) (result UserAssignedIdentitiesListResultIterator, err error)
- func (client UserAssignedIdentitiesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client UserAssignedIdentitiesClient) ListBySubscriptionResponder(resp *http.Response) (result UserAssignedIdentitiesListResult, err error)
- func (client UserAssignedIdentitiesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client UserAssignedIdentitiesClient) Update(ctx context.Context, resourceGroupName string, resourceName string, ...) (result Identity, err error)
- func (client UserAssignedIdentitiesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client UserAssignedIdentitiesClient) UpdateResponder(resp *http.Response) (result Identity, err error)
- func (client UserAssignedIdentitiesClient) UpdateSender(req *http.Request) (*http.Response, error)
- type UserAssignedIdentitiesListResult
- type UserAssignedIdentitiesListResultIterator
- func (iter *UserAssignedIdentitiesListResultIterator) Next() error
- func (iter *UserAssignedIdentitiesListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter UserAssignedIdentitiesListResultIterator) NotDone() bool
- func (iter UserAssignedIdentitiesListResultIterator) Response() UserAssignedIdentitiesListResult
- func (iter UserAssignedIdentitiesListResultIterator) Value() Identity
- type UserAssignedIdentitiesListResultPage
- func (page *UserAssignedIdentitiesListResultPage) Next() error
- func (page *UserAssignedIdentitiesListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page UserAssignedIdentitiesListResultPage) NotDone() bool
- func (page UserAssignedIdentitiesListResultPage) Response() UserAssignedIdentitiesListResult
- func (page UserAssignedIdentitiesListResultPage) Values() []Identity
- type UserAssignedIdentityProperties
Constants ¶
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 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 BaseClient ¶
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 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 ¶
MarshalJSON is the custom marshaler for Identity.
func (*Identity) UnmarshalJSON ¶
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 ¶
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(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 ¶
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 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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 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 ¶
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(cur UserAssignedIdentitiesListResult, 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.
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.