authorization

package
v14.2.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Mar 5, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package authorization implements the Azure ARM Authorization service API version .

Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Authorization
	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 Authorization.

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 ClassicAdministrator

type ClassicAdministrator struct {
	// ID - The ID of the administrator.
	ID *string `json:"id,omitempty"`
	// Name - The name of the administrator.
	Name *string `json:"name,omitempty"`
	// Type - The type of the administrator.
	Type *string `json:"type,omitempty"`
	// ClassicAdministratorProperties - Properties for the classic administrator.
	*ClassicAdministratorProperties `json:"properties,omitempty"`
}

ClassicAdministrator classic Administrators

func (*ClassicAdministrator) UnmarshalJSON

func (ca *ClassicAdministrator) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ClassicAdministrator struct.

type ClassicAdministratorListResult

type ClassicAdministratorListResult struct {
	autorest.Response `json:"-"`
	// Value - An array of administrators.
	Value *[]ClassicAdministrator `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ClassicAdministratorListResult classicAdministrator list result information.

func (ClassicAdministratorListResult) IsEmpty

func (calr ClassicAdministratorListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ClassicAdministratorListResultIterator

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

ClassicAdministratorListResultIterator provides access to a complete listing of ClassicAdministrator values.

func (*ClassicAdministratorListResultIterator) 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.

func (ClassicAdministratorListResultIterator) NotDone

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

func (ClassicAdministratorListResultIterator) Response

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

func (ClassicAdministratorListResultIterator) Value

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

type ClassicAdministratorListResultPage

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

ClassicAdministratorListResultPage contains a page of ClassicAdministrator values.

func (*ClassicAdministratorListResultPage) 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.

func (ClassicAdministratorListResultPage) NotDone

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

func (ClassicAdministratorListResultPage) Response

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

func (ClassicAdministratorListResultPage) Values

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

type ClassicAdministratorProperties

type ClassicAdministratorProperties struct {
	// EmailAddress - The email address of the administrator.
	EmailAddress *string `json:"emailAddress,omitempty"`
	// Role - The role of the administrator.
	Role *string `json:"role,omitempty"`
}

ClassicAdministratorProperties classic Administrator properties.

type ClassicAdministratorsClient

type ClassicAdministratorsClient struct {
	BaseClient
}

ClassicAdministratorsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewClassicAdministratorsClient

func NewClassicAdministratorsClient(subscriptionID string) ClassicAdministratorsClient

NewClassicAdministratorsClient creates an instance of the ClassicAdministratorsClient client.

func NewClassicAdministratorsClientWithBaseURI

func NewClassicAdministratorsClientWithBaseURI(baseURI string, subscriptionID string) ClassicAdministratorsClient

NewClassicAdministratorsClientWithBaseURI creates an instance of the ClassicAdministratorsClient client.

func (ClassicAdministratorsClient) List

List gets service administrator, account administrator, and co-administrators for the subscription.

func (ClassicAdministratorsClient) ListComplete

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

func (ClassicAdministratorsClient) ListPreparer

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

ListPreparer prepares the List request.

func (ClassicAdministratorsClient) ListResponder

func (client ClassicAdministratorsClient) ListResponder(resp *http.Response) (result ClassicAdministratorListResult, err error)

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

func (ClassicAdministratorsClient) ListSender

func (client ClassicAdministratorsClient) 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 Permission

type Permission struct {
	// Actions - Allowed actions.
	Actions *[]string `json:"actions,omitempty"`
	// NotActions - Denied actions.
	NotActions *[]string `json:"notActions,omitempty"`
	// DataActions - Allowed Data actions.
	DataActions *[]string `json:"dataActions,omitempty"`
	// NotDataActions - Denied Data actions.
	NotDataActions *[]string `json:"notDataActions,omitempty"`
}

Permission role definition permissions.

type PermissionGetResult

type PermissionGetResult struct {
	autorest.Response `json:"-"`
	// Value - An array of permissions.
	Value *[]Permission `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

PermissionGetResult permissions information.

func (PermissionGetResult) IsEmpty

func (pgr PermissionGetResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PermissionGetResultIterator

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

PermissionGetResultIterator provides access to a complete listing of Permission values.

func (*PermissionGetResultIterator) Next

func (iter *PermissionGetResultIterator) 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.

func (PermissionGetResultIterator) NotDone

func (iter PermissionGetResultIterator) NotDone() bool

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

func (PermissionGetResultIterator) Response

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

func (PermissionGetResultIterator) Value

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

type PermissionGetResultPage

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

PermissionGetResultPage contains a page of Permission values.

func (*PermissionGetResultPage) Next

func (page *PermissionGetResultPage) 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.

func (PermissionGetResultPage) NotDone

func (page PermissionGetResultPage) NotDone() bool

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

func (PermissionGetResultPage) Response

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

func (PermissionGetResultPage) Values

func (page PermissionGetResultPage) Values() []Permission

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

type PermissionsClient

type PermissionsClient struct {
	BaseClient
}

PermissionsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewPermissionsClient

func NewPermissionsClient(subscriptionID string) PermissionsClient

NewPermissionsClient creates an instance of the PermissionsClient client.

func NewPermissionsClientWithBaseURI

func NewPermissionsClientWithBaseURI(baseURI string, subscriptionID string) PermissionsClient

NewPermissionsClientWithBaseURI creates an instance of the PermissionsClient client.

func (PermissionsClient) ListForResource

func (client PermissionsClient) ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (result PermissionGetResultPage, err error)

ListForResource gets all permissions the caller has for a resource.

resourceGroupName is the name of the resource group. resourceProviderNamespace is the namespace of the resource provider. parentResourcePath is the parent resource identity. resourceType is the resource type of the resource. resourceName is the name of the resource to get the permissions for.

func (PermissionsClient) ListForResourceComplete

func (client PermissionsClient) ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (result PermissionGetResultIterator, err error)

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

func (PermissionsClient) ListForResourceGroup

func (client PermissionsClient) ListForResourceGroup(ctx context.Context, resourceGroupName string) (result PermissionGetResultPage, err error)

ListForResourceGroup gets all permissions the caller has for a resource group.

resourceGroupName is the name of the resource group.

func (PermissionsClient) ListForResourceGroupComplete

func (client PermissionsClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string) (result PermissionGetResultIterator, err error)

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

func (PermissionsClient) ListForResourceGroupPreparer

func (client PermissionsClient) ListForResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListForResourceGroupPreparer prepares the ListForResourceGroup request.

func (PermissionsClient) ListForResourceGroupResponder

func (client PermissionsClient) ListForResourceGroupResponder(resp *http.Response) (result PermissionGetResult, err error)

ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.

func (PermissionsClient) ListForResourceGroupSender

func (client PermissionsClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (PermissionsClient) ListForResourcePreparer

func (client PermissionsClient) ListForResourcePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (*http.Request, error)

ListForResourcePreparer prepares the ListForResource request.

func (PermissionsClient) ListForResourceResponder

func (client PermissionsClient) ListForResourceResponder(resp *http.Response) (result PermissionGetResult, err error)

ListForResourceResponder handles the response to the ListForResource request. The method always closes the http.Response Body.

func (PermissionsClient) ListForResourceSender

func (client PermissionsClient) ListForResourceSender(req *http.Request) (*http.Response, error)

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

type ProviderOperation

type ProviderOperation struct {
	// Name - The operation name.
	Name *string `json:"name,omitempty"`
	// DisplayName - The operation display name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - The operation description.
	Description *string `json:"description,omitempty"`
	// Origin - The operation origin.
	Origin *string `json:"origin,omitempty"`
	// Properties - The operation properties.
	Properties interface{} `json:"properties,omitempty"`
	// IsDataAction - The dataAction flag to specify the operation type.
	IsDataAction *bool `json:"isDataAction,omitempty"`
}

ProviderOperation operation

type ProviderOperationsMetadata

type ProviderOperationsMetadata struct {
	autorest.Response `json:"-"`
	// ID - The provider id.
	ID *string `json:"id,omitempty"`
	// Name - The provider name.
	Name *string `json:"name,omitempty"`
	// Type - The provider type.
	Type *string `json:"type,omitempty"`
	// DisplayName - The provider display name.
	DisplayName *string `json:"displayName,omitempty"`
	// ResourceTypes - The provider resource types
	ResourceTypes *[]ResourceType `json:"resourceTypes,omitempty"`
	// Operations - The provider operations.
	Operations *[]ProviderOperation `json:"operations,omitempty"`
}

ProviderOperationsMetadata provider Operations metadata

type ProviderOperationsMetadataClient

type ProviderOperationsMetadataClient struct {
	BaseClient
}

ProviderOperationsMetadataClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewProviderOperationsMetadataClient

func NewProviderOperationsMetadataClient(subscriptionID string) ProviderOperationsMetadataClient

NewProviderOperationsMetadataClient creates an instance of the ProviderOperationsMetadataClient client.

func NewProviderOperationsMetadataClientWithBaseURI

func NewProviderOperationsMetadataClientWithBaseURI(baseURI string, subscriptionID string) ProviderOperationsMetadataClient

NewProviderOperationsMetadataClientWithBaseURI creates an instance of the ProviderOperationsMetadataClient client.

func (ProviderOperationsMetadataClient) Get

func (client ProviderOperationsMetadataClient) Get(ctx context.Context, resourceProviderNamespace string, expand string) (result ProviderOperationsMetadata, err error)

Get gets provider operations metadata for the specified resource provider.

resourceProviderNamespace is the namespace of the resource provider. expand is specifies whether to expand the values.

func (ProviderOperationsMetadataClient) GetPreparer

func (client ProviderOperationsMetadataClient) GetPreparer(ctx context.Context, resourceProviderNamespace string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProviderOperationsMetadataClient) GetResponder

func (client ProviderOperationsMetadataClient) GetResponder(resp *http.Response) (result ProviderOperationsMetadata, err error)

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

func (ProviderOperationsMetadataClient) GetSender

func (client ProviderOperationsMetadataClient) 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 (ProviderOperationsMetadataClient) List

List gets provider operations metadata for all resource providers.

expand is specifies whether to expand the values.

func (ProviderOperationsMetadataClient) ListComplete

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

func (ProviderOperationsMetadataClient) ListPreparer

func (client ProviderOperationsMetadataClient) ListPreparer(ctx context.Context, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (ProviderOperationsMetadataClient) ListResponder

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

func (ProviderOperationsMetadataClient) ListSender

func (client ProviderOperationsMetadataClient) 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 ProviderOperationsMetadataListResult

type ProviderOperationsMetadataListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of providers.
	Value *[]ProviderOperationsMetadata `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ProviderOperationsMetadataListResult provider operations metadata list

func (ProviderOperationsMetadataListResult) IsEmpty

IsEmpty returns true if the ListResult contains no values.

type ProviderOperationsMetadataListResultIterator

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

ProviderOperationsMetadataListResultIterator provides access to a complete listing of ProviderOperationsMetadata values.

func (*ProviderOperationsMetadataListResultIterator) 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.

func (ProviderOperationsMetadataListResultIterator) NotDone

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

func (ProviderOperationsMetadataListResultIterator) Response

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

func (ProviderOperationsMetadataListResultIterator) Value

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

type ProviderOperationsMetadataListResultPage

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

ProviderOperationsMetadataListResultPage contains a page of ProviderOperationsMetadata values.

func (*ProviderOperationsMetadataListResultPage) 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.

func (ProviderOperationsMetadataListResultPage) NotDone

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

func (ProviderOperationsMetadataListResultPage) Response

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

func (ProviderOperationsMetadataListResultPage) Values

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

type ResourceType

type ResourceType struct {
	// Name - The resource type name.
	Name *string `json:"name,omitempty"`
	// DisplayName - The resource type display name.
	DisplayName *string `json:"displayName,omitempty"`
	// Operations - The resource type operations.
	Operations *[]ProviderOperation `json:"operations,omitempty"`
}

ResourceType resource Type

type RoleAssignment

type RoleAssignment struct {
	autorest.Response `json:"-"`
	// ID - The role assignment ID.
	ID *string `json:"id,omitempty"`
	// Name - The role assignment name.
	Name *string `json:"name,omitempty"`
	// Type - The role assignment type.
	Type *string `json:"type,omitempty"`
	// RoleAssignmentPropertiesWithScope - Role assignment properties.
	*RoleAssignmentPropertiesWithScope `json:"properties,omitempty"`
}

RoleAssignment role Assignments

func (*RoleAssignment) UnmarshalJSON

func (ra *RoleAssignment) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoleAssignment struct.

type RoleAssignmentCreateParameters

type RoleAssignmentCreateParameters struct {
	// RoleAssignmentProperties - Role assignment properties.
	*RoleAssignmentProperties `json:"properties,omitempty"`
}

RoleAssignmentCreateParameters role assignment create parameters.

func (*RoleAssignmentCreateParameters) UnmarshalJSON

func (racp *RoleAssignmentCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoleAssignmentCreateParameters struct.

type RoleAssignmentFilter

type RoleAssignmentFilter struct {
	// PrincipalID - Returns role assignment of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`
	// CanDelegate - The Delegation flag for the roleassignment
	CanDelegate *bool `json:"canDelegate,omitempty"`
}

RoleAssignmentFilter role Assignments filter

type RoleAssignmentListResult

type RoleAssignmentListResult struct {
	autorest.Response `json:"-"`
	// Value - Role assignment list.
	Value *[]RoleAssignment `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

RoleAssignmentListResult role assignment list operation result.

func (RoleAssignmentListResult) IsEmpty

func (ralr RoleAssignmentListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RoleAssignmentListResultIterator

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

RoleAssignmentListResultIterator provides access to a complete listing of RoleAssignment values.

func (*RoleAssignmentListResultIterator) 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.

func (RoleAssignmentListResultIterator) NotDone

func (iter RoleAssignmentListResultIterator) NotDone() bool

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

func (RoleAssignmentListResultIterator) Response

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

func (RoleAssignmentListResultIterator) Value

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

type RoleAssignmentListResultPage

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

RoleAssignmentListResultPage contains a page of RoleAssignment values.

func (*RoleAssignmentListResultPage) Next

func (page *RoleAssignmentListResultPage) 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.

func (RoleAssignmentListResultPage) NotDone

func (page RoleAssignmentListResultPage) NotDone() bool

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

func (RoleAssignmentListResultPage) Response

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

func (RoleAssignmentListResultPage) Values

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

type RoleAssignmentProperties

type RoleAssignmentProperties struct {
	// RoleDefinitionID - The role definition ID used in the role assignment.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
	// PrincipalID - The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group.
	PrincipalID *string `json:"principalId,omitempty"`
	// CanDelegate - The delgation flag used for creating a role assignment
	CanDelegate *bool `json:"canDelegate,omitempty"`
}

RoleAssignmentProperties role assignment properties.

type RoleAssignmentPropertiesWithScope

type RoleAssignmentPropertiesWithScope struct {
	// Scope - The role assignment scope.
	Scope *string `json:"scope,omitempty"`
	// RoleDefinitionID - The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
	// PrincipalID - The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`
	// CanDelegate - The Delegation flag for the roleassignment
	CanDelegate *bool `json:"canDelegate,omitempty"`
}

RoleAssignmentPropertiesWithScope role assignment properties with scope.

type RoleAssignmentsClient

type RoleAssignmentsClient struct {
	BaseClient
}

RoleAssignmentsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewRoleAssignmentsClient

func NewRoleAssignmentsClient(subscriptionID string) RoleAssignmentsClient

NewRoleAssignmentsClient creates an instance of the RoleAssignmentsClient client.

func NewRoleAssignmentsClientWithBaseURI

func NewRoleAssignmentsClientWithBaseURI(baseURI string, subscriptionID string) RoleAssignmentsClient

NewRoleAssignmentsClientWithBaseURI creates an instance of the RoleAssignmentsClient client.

func (RoleAssignmentsClient) Create

func (client RoleAssignmentsClient) Create(ctx context.Context, scope string, roleAssignmentName string, parameters RoleAssignmentCreateParameters) (result RoleAssignment, err error)

Create creates a role assignment.

scope is the scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource. roleAssignmentName is the name of the role assignment to create. It can be any valid GUID. parameters is parameters for the role assignment.

func (RoleAssignmentsClient) CreateByID

func (client RoleAssignmentsClient) CreateByID(ctx context.Context, roleID string, parameters RoleAssignmentCreateParameters) (result RoleAssignment, err error)

CreateByID creates a role assignment by ID.

roleID is the ID of the role assignment to create. parameters is parameters for the role assignment.

func (RoleAssignmentsClient) CreateByIDPreparer

func (client RoleAssignmentsClient) CreateByIDPreparer(ctx context.Context, roleID string, parameters RoleAssignmentCreateParameters) (*http.Request, error)

CreateByIDPreparer prepares the CreateByID request.

func (RoleAssignmentsClient) CreateByIDResponder

func (client RoleAssignmentsClient) CreateByIDResponder(resp *http.Response) (result RoleAssignment, err error)

CreateByIDResponder handles the response to the CreateByID request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) CreateByIDSender

func (client RoleAssignmentsClient) CreateByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) CreatePreparer

func (client RoleAssignmentsClient) CreatePreparer(ctx context.Context, scope string, roleAssignmentName string, parameters RoleAssignmentCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (RoleAssignmentsClient) CreateResponder

func (client RoleAssignmentsClient) CreateResponder(resp *http.Response) (result RoleAssignment, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) CreateSender

func (client RoleAssignmentsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) Delete

func (client RoleAssignmentsClient) Delete(ctx context.Context, scope string, roleAssignmentName string) (result RoleAssignment, err error)

Delete deletes a role assignment.

scope is the scope of the role assignment to delete. roleAssignmentName is the name of the role assignment to delete.

func (RoleAssignmentsClient) DeleteByID

func (client RoleAssignmentsClient) DeleteByID(ctx context.Context, roleID string) (result RoleAssignment, err error)

DeleteByID deletes a role assignment.

roleID is the ID of the role assignment to delete.

func (RoleAssignmentsClient) DeleteByIDPreparer

func (client RoleAssignmentsClient) DeleteByIDPreparer(ctx context.Context, roleID string) (*http.Request, error)

DeleteByIDPreparer prepares the DeleteByID request.

func (RoleAssignmentsClient) DeleteByIDResponder

func (client RoleAssignmentsClient) DeleteByIDResponder(resp *http.Response) (result RoleAssignment, err error)

DeleteByIDResponder handles the response to the DeleteByID request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) DeleteByIDSender

func (client RoleAssignmentsClient) DeleteByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) DeletePreparer

func (client RoleAssignmentsClient) DeletePreparer(ctx context.Context, scope string, roleAssignmentName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RoleAssignmentsClient) DeleteResponder

func (client RoleAssignmentsClient) DeleteResponder(resp *http.Response) (result RoleAssignment, err error)

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

func (RoleAssignmentsClient) DeleteSender

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

func (client RoleAssignmentsClient) Get(ctx context.Context, scope string, roleAssignmentName string) (result RoleAssignment, err error)

Get get the specified role assignment.

scope is the scope of the role assignment. roleAssignmentName is the name of the role assignment to get.

func (RoleAssignmentsClient) GetByID

func (client RoleAssignmentsClient) GetByID(ctx context.Context, roleID string) (result RoleAssignment, err error)

GetByID gets a role assignment by ID.

roleID is the ID of the role assignment to get.

func (RoleAssignmentsClient) GetByIDPreparer

func (client RoleAssignmentsClient) GetByIDPreparer(ctx context.Context, roleID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (RoleAssignmentsClient) GetByIDResponder

func (client RoleAssignmentsClient) GetByIDResponder(resp *http.Response) (result RoleAssignment, err error)

GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) GetByIDSender

func (client RoleAssignmentsClient) GetByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) GetPreparer

func (client RoleAssignmentsClient) GetPreparer(ctx context.Context, scope string, roleAssignmentName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RoleAssignmentsClient) GetResponder

func (client RoleAssignmentsClient) GetResponder(resp *http.Response) (result RoleAssignment, err error)

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

func (RoleAssignmentsClient) GetSender

func (client RoleAssignmentsClient) 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 (RoleAssignmentsClient) List

func (client RoleAssignmentsClient) List(ctx context.Context, filter string) (result RoleAssignmentListResultPage, err error)

List gets all role assignments for the subscription.

filter is the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListComplete

func (client RoleAssignmentsClient) ListComplete(ctx context.Context, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForResource

func (client RoleAssignmentsClient) ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result RoleAssignmentListResultPage, err error)

ListForResource gets role assignments for a resource.

resourceGroupName is the name of the resource group. resourceProviderNamespace is the namespace of the resource provider. parentResourcePath is the parent resource identity. resourceType is the resource type of the resource. resourceName is the name of the resource to get role assignments for. filter is the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListForResourceComplete

func (client RoleAssignmentsClient) ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForResourceGroup

func (client RoleAssignmentsClient) ListForResourceGroup(ctx context.Context, resourceGroupName string, filter string) (result RoleAssignmentListResultPage, err error)

ListForResourceGroup gets role assignments for a resource group.

resourceGroupName is the name of the resource group. filter is the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListForResourceGroupComplete

func (client RoleAssignmentsClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForResourceGroupPreparer

func (client RoleAssignmentsClient) ListForResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string) (*http.Request, error)

ListForResourceGroupPreparer prepares the ListForResourceGroup request.

func (RoleAssignmentsClient) ListForResourceGroupResponder

func (client RoleAssignmentsClient) ListForResourceGroupResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) ListForResourceGroupSender

func (client RoleAssignmentsClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) ListForResourcePreparer

func (client RoleAssignmentsClient) ListForResourcePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (*http.Request, error)

ListForResourcePreparer prepares the ListForResource request.

func (RoleAssignmentsClient) ListForResourceResponder

func (client RoleAssignmentsClient) ListForResourceResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

ListForResourceResponder handles the response to the ListForResource request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) ListForResourceSender

func (client RoleAssignmentsClient) ListForResourceSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) ListForScope

func (client RoleAssignmentsClient) ListForScope(ctx context.Context, scope string, filter string) (result RoleAssignmentListResultPage, err error)

ListForScope gets role assignments for a scope.

scope is the scope of the role assignments. filter is the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListForScopeComplete

func (client RoleAssignmentsClient) ListForScopeComplete(ctx context.Context, scope string, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForScopePreparer

func (client RoleAssignmentsClient) ListForScopePreparer(ctx context.Context, scope string, filter string) (*http.Request, error)

ListForScopePreparer prepares the ListForScope request.

func (RoleAssignmentsClient) ListForScopeResponder

func (client RoleAssignmentsClient) ListForScopeResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

ListForScopeResponder handles the response to the ListForScope request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) ListForScopeSender

func (client RoleAssignmentsClient) ListForScopeSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) ListPreparer

func (client RoleAssignmentsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (RoleAssignmentsClient) ListResponder

func (client RoleAssignmentsClient) ListResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

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

func (RoleAssignmentsClient) ListSender

func (client RoleAssignmentsClient) 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 RoleDefinition

type RoleDefinition struct {
	autorest.Response `json:"-"`
	// ID - The role definition ID.
	ID *string `json:"id,omitempty"`
	// Name - The role definition name.
	Name *string `json:"name,omitempty"`
	// Type - The role definition type.
	Type *string `json:"type,omitempty"`
	// RoleDefinitionProperties - Role definition properties.
	*RoleDefinitionProperties `json:"properties,omitempty"`
}

RoleDefinition role definition.

func (*RoleDefinition) UnmarshalJSON

func (rd *RoleDefinition) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoleDefinition struct.

type RoleDefinitionFilter

type RoleDefinitionFilter struct {
	// RoleName - Returns role definition with the specific name.
	RoleName *string `json:"roleName,omitempty"`
}

RoleDefinitionFilter role Definitions filter

type RoleDefinitionListResult

type RoleDefinitionListResult struct {
	autorest.Response `json:"-"`
	// Value - Role definition list.
	Value *[]RoleDefinition `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

RoleDefinitionListResult role definition list operation result.

func (RoleDefinitionListResult) IsEmpty

func (rdlr RoleDefinitionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RoleDefinitionListResultIterator

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

RoleDefinitionListResultIterator provides access to a complete listing of RoleDefinition values.

func (*RoleDefinitionListResultIterator) 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.

func (RoleDefinitionListResultIterator) NotDone

func (iter RoleDefinitionListResultIterator) NotDone() bool

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

func (RoleDefinitionListResultIterator) Response

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

func (RoleDefinitionListResultIterator) Value

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

type RoleDefinitionListResultPage

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

RoleDefinitionListResultPage contains a page of RoleDefinition values.

func (*RoleDefinitionListResultPage) Next

func (page *RoleDefinitionListResultPage) 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.

func (RoleDefinitionListResultPage) NotDone

func (page RoleDefinitionListResultPage) NotDone() bool

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

func (RoleDefinitionListResultPage) Response

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

func (RoleDefinitionListResultPage) Values

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

type RoleDefinitionProperties

type RoleDefinitionProperties struct {
	// RoleName - The role name.
	RoleName *string `json:"roleName,omitempty"`
	// Description - The role definition description.
	Description *string `json:"description,omitempty"`
	// RoleType - The role type.
	RoleType *string `json:"type,omitempty"`
	// Permissions - Role definition permissions.
	Permissions *[]Permission `json:"permissions,omitempty"`
	// AssignableScopes - Role definition assignable scopes.
	AssignableScopes *[]string `json:"assignableScopes,omitempty"`
}

RoleDefinitionProperties role definition properties.

type RoleDefinitionsClient

type RoleDefinitionsClient struct {
	BaseClient
}

RoleDefinitionsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewRoleDefinitionsClient

func NewRoleDefinitionsClient(subscriptionID string) RoleDefinitionsClient

NewRoleDefinitionsClient creates an instance of the RoleDefinitionsClient client.

func NewRoleDefinitionsClientWithBaseURI

func NewRoleDefinitionsClientWithBaseURI(baseURI string, subscriptionID string) RoleDefinitionsClient

NewRoleDefinitionsClientWithBaseURI creates an instance of the RoleDefinitionsClient client.

func (RoleDefinitionsClient) CreateOrUpdate

func (client RoleDefinitionsClient) CreateOrUpdate(ctx context.Context, scope string, roleDefinitionID string, roleDefinition RoleDefinition) (result RoleDefinition, err error)

CreateOrUpdate creates or updates a role definition.

scope is the scope of the role definition. roleDefinitionID is the ID of the role definition. roleDefinition is the values for the role definition.

func (RoleDefinitionsClient) CreateOrUpdatePreparer

func (client RoleDefinitionsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, roleDefinitionID string, roleDefinition RoleDefinition) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RoleDefinitionsClient) CreateOrUpdateResponder

func (client RoleDefinitionsClient) CreateOrUpdateResponder(resp *http.Response) (result RoleDefinition, err error)

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

func (RoleDefinitionsClient) CreateOrUpdateSender

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

func (client RoleDefinitionsClient) Delete(ctx context.Context, scope string, roleDefinitionID string) (result RoleDefinition, err error)

Delete deletes a role definition.

scope is the scope of the role definition. roleDefinitionID is the ID of the role definition to delete.

func (RoleDefinitionsClient) DeletePreparer

func (client RoleDefinitionsClient) DeletePreparer(ctx context.Context, scope string, roleDefinitionID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RoleDefinitionsClient) DeleteResponder

func (client RoleDefinitionsClient) DeleteResponder(resp *http.Response) (result RoleDefinition, err error)

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

func (RoleDefinitionsClient) DeleteSender

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

func (client RoleDefinitionsClient) Get(ctx context.Context, scope string, roleDefinitionID string) (result RoleDefinition, err error)

Get get role definition by name (GUID).

scope is the scope of the role definition. roleDefinitionID is the ID of the role definition.

func (RoleDefinitionsClient) GetByID

func (client RoleDefinitionsClient) GetByID(ctx context.Context, roleID string) (result RoleDefinition, err error)

GetByID gets a role definition by ID.

roleID is the fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

func (RoleDefinitionsClient) GetByIDPreparer

func (client RoleDefinitionsClient) GetByIDPreparer(ctx context.Context, roleID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (RoleDefinitionsClient) GetByIDResponder

func (client RoleDefinitionsClient) GetByIDResponder(resp *http.Response) (result RoleDefinition, err error)

GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.

func (RoleDefinitionsClient) GetByIDSender

func (client RoleDefinitionsClient) GetByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleDefinitionsClient) GetPreparer

func (client RoleDefinitionsClient) GetPreparer(ctx context.Context, scope string, roleDefinitionID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RoleDefinitionsClient) GetResponder

func (client RoleDefinitionsClient) GetResponder(resp *http.Response) (result RoleDefinition, err error)

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

func (RoleDefinitionsClient) GetSender

func (client RoleDefinitionsClient) 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 (RoleDefinitionsClient) List

func (client RoleDefinitionsClient) List(ctx context.Context, scope string, filter string) (result RoleDefinitionListResultPage, err error)

List get all role definitions that are applicable at scope and above.

scope is the scope of the role definition. filter is the filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.

func (RoleDefinitionsClient) ListComplete

func (client RoleDefinitionsClient) ListComplete(ctx context.Context, scope string, filter string) (result RoleDefinitionListResultIterator, err error)

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

func (RoleDefinitionsClient) ListPreparer

func (client RoleDefinitionsClient) ListPreparer(ctx context.Context, scope string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (RoleDefinitionsClient) ListResponder

func (client RoleDefinitionsClient) ListResponder(resp *http.Response) (result RoleDefinitionListResult, err error)

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

func (RoleDefinitionsClient) ListSender

func (client RoleDefinitionsClient) 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.

Jump to

Keyboard shortcuts

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