authorization

package
v11.3.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2017 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package authorization implements the Azure ARM Authorization service API version 2015-07-01.

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 ClassicAdministrator 

type ClassicAdministrator struct {
	ID         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Type       *string                         `json:"type,omitempty"`
	Properties *ClassicAdministratorProperties `json:"properties,omitempty"`
}

ClassicAdministrator is classic Administrators

type ClassicAdministratorListResult 

type ClassicAdministratorListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ClassicAdministrator `json:"value,omitempty"`
	NextLink          *string                 `json:"nextLink,omitempty"`
}

ClassicAdministratorListResult is classicAdministrator list result information.

func (ClassicAdministratorListResult) ClassicAdministratorListResultPreparer 

func (client ClassicAdministratorListResult) ClassicAdministratorListResultPreparer() (*http.Request, error)

ClassicAdministratorListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ClassicAdministratorProperties 

type ClassicAdministratorProperties struct {
	EmailAddress *string `json:"emailAddress,omitempty"`
	Role         *string `json:"role,omitempty"`
}

ClassicAdministratorProperties is classic Administrator properties.

type ClassicAdministratorsClient 

type ClassicAdministratorsClient struct {
	ManagementClient
}

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 

func (client ClassicAdministratorsClient) List() (result ClassicAdministratorListResult, err error)

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

func (ClassicAdministratorsClient) ListComplete 

func (client ClassicAdministratorsClient) ListComplete(cancel <-chan struct{}) (<-chan ClassicAdministrator, <-chan error)

ListComplete gets all elements from the list without paging.

func (ClassicAdministratorsClient) ListNextResults 

func (client ClassicAdministratorsClient) ListNextResults(lastResults ClassicAdministratorListResult) (result ClassicAdministratorListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (ClassicAdministratorsClient) ListPreparer 

func (client ClassicAdministratorsClient) ListPreparer() (*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 ManagementClient 

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

ManagementClient is the base client for Authorization.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type Permission 

type Permission struct {
	Actions    *[]string `json:"actions,omitempty"`
	NotActions *[]string `json:"notActions,omitempty"`
}

Permission is role definition permissions.

type PermissionGetResult 

type PermissionGetResult struct {
	autorest.Response `json:"-"`
	Value             *[]Permission `json:"value,omitempty"`
	NextLink          *string       `json:"nextLink,omitempty"`
}

PermissionGetResult is permissions information.

func (PermissionGetResult) PermissionGetResultPreparer 

func (client PermissionGetResult) PermissionGetResultPreparer() (*http.Request, error)

PermissionGetResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type PermissionsClient 

type PermissionsClient struct {
	ManagementClient
}

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(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (result PermissionGetResult, err error)

ListForResource gets all permissions the caller has for a resource.

resourceGroupName is the name of the resource group containing the resource. The name is case insensitive. 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(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, cancel <-chan struct{}) (<-chan Permission, <-chan error)

ListForResourceComplete gets all elements from the list without paging.

func (PermissionsClient) ListForResourceGroup 

func (client PermissionsClient) ListForResourceGroup(resourceGroupName string) (result PermissionGetResult, err error)

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

resourceGroupName is the name of the resource group to get the permissions for. The name is case insensitive.

func (PermissionsClient) ListForResourceGroupComplete 

func (client PermissionsClient) ListForResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan Permission, <-chan error)

ListForResourceGroupComplete gets all elements from the list without paging.

func (PermissionsClient) ListForResourceGroupNextResults 

func (client PermissionsClient) ListForResourceGroupNextResults(lastResults PermissionGetResult) (result PermissionGetResult, err error)

ListForResourceGroupNextResults retrieves the next set of results, if any.

func (PermissionsClient) ListForResourceGroupPreparer 

func (client PermissionsClient) ListForResourceGroupPreparer(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) ListForResourceNextResults 

func (client PermissionsClient) ListForResourceNextResults(lastResults PermissionGetResult) (result PermissionGetResult, err error)

ListForResourceNextResults retrieves the next set of results, if any.

func (PermissionsClient) ListForResourcePreparer 

func (client PermissionsClient) ListForResourcePreparer(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        *string                 `json:"name,omitempty"`
	DisplayName *string                 `json:"displayName,omitempty"`
	Description *string                 `json:"description,omitempty"`
	Origin      *string                 `json:"origin,omitempty"`
	Properties  *map[string]interface{} `json:"properties,omitempty"`
}

ProviderOperation is operation

type ProviderOperationsMetadata 

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

ProviderOperationsMetadata is provider Operations metadata

type ProviderOperationsMetadataClient 

type ProviderOperationsMetadataClient struct {
	ManagementClient
}

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(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(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 

func (client ProviderOperationsMetadataClient) List(expand string) (result ProviderOperationsMetadataListResult, err error)

List gets provider operations metadata for all resource providers.

expand is specifies whether to expand the values.

func (ProviderOperationsMetadataClient) ListComplete 

func (client ProviderOperationsMetadataClient) ListComplete(expand string, cancel <-chan struct{}) (<-chan ProviderOperationsMetadata, <-chan error)

ListComplete gets all elements from the list without paging.

func (ProviderOperationsMetadataClient) ListNextResults 

func (client ProviderOperationsMetadataClient) ListNextResults(lastResults ProviderOperationsMetadataListResult) (result ProviderOperationsMetadataListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (ProviderOperationsMetadataClient) ListPreparer 

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

ListPreparer prepares the List request.

func (ProviderOperationsMetadataClient) ListResponder 

func (client ProviderOperationsMetadataClient) ListResponder(resp *http.Response) (result ProviderOperationsMetadataListResult, err error)

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             *[]ProviderOperationsMetadata `json:"value,omitempty"`
	NextLink          *string                       `json:"nextLink,omitempty"`
}

ProviderOperationsMetadataListResult is provider operations metadata list

func (ProviderOperationsMetadataListResult) ProviderOperationsMetadataListResultPreparer 

func (client ProviderOperationsMetadataListResult) ProviderOperationsMetadataListResultPreparer() (*http.Request, error)

ProviderOperationsMetadataListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ResourceType 

type ResourceType struct {
	Name        *string              `json:"name,omitempty"`
	DisplayName *string              `json:"displayName,omitempty"`
	Operations  *[]ProviderOperation `json:"operations,omitempty"`
}

ResourceType is resource Type

type RoleAssignment 

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

RoleAssignment is role Assignments

type RoleAssignmentCreateParameters 

type RoleAssignmentCreateParameters struct {
	Properties *RoleAssignmentProperties `json:"properties,omitempty"`
}

RoleAssignmentCreateParameters is role assignment create parameters.

type RoleAssignmentFilter 

type RoleAssignmentFilter struct {
	PrincipalID *string `json:"principalId,omitempty"`
}

RoleAssignmentFilter is role Assignments filter

type RoleAssignmentListResult 

type RoleAssignmentListResult struct {
	autorest.Response `json:"-"`
	Value             *[]RoleAssignment `json:"value,omitempty"`
	NextLink          *string           `json:"nextLink,omitempty"`
}

RoleAssignmentListResult is role assignment list operation result.

func (RoleAssignmentListResult) RoleAssignmentListResultPreparer 

func (client RoleAssignmentListResult) RoleAssignmentListResultPreparer() (*http.Request, error)

RoleAssignmentListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type RoleAssignmentProperties 

type RoleAssignmentProperties struct {
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
	PrincipalID      *string `json:"principalId,omitempty"`
}

RoleAssignmentProperties is role assignment properties.

type RoleAssignmentPropertiesWithScope 

type RoleAssignmentPropertiesWithScope struct {
	Scope            *string `json:"scope,omitempty"`
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
	PrincipalID      *string `json:"principalId,omitempty"`
}

RoleAssignmentPropertiesWithScope is role assignment properties with scope.

type RoleAssignmentsClient 

type RoleAssignmentsClient struct {
	ManagementClient
}

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(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(roleAssignmentID string, parameters RoleAssignmentCreateParameters) (result RoleAssignment, err error)

CreateByID creates a role assignment by ID.

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

func (RoleAssignmentsClient) CreateByIDPreparer 

func (client RoleAssignmentsClient) CreateByIDPreparer(roleAssignmentID 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(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(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(roleAssignmentID string) (result RoleAssignment, err error)

DeleteByID deletes a role assignment.

roleAssignmentID is the ID of the role assignment to delete.

func (RoleAssignmentsClient) DeleteByIDPreparer 

func (client RoleAssignmentsClient) DeleteByIDPreparer(roleAssignmentID 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(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(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(roleAssignmentID string) (result RoleAssignment, err error)

GetByID gets a role assignment by ID.

roleAssignmentID is the ID of the role assignment to get.

func (RoleAssignmentsClient) GetByIDPreparer 

func (client RoleAssignmentsClient) GetByIDPreparer(roleAssignmentID 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(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(filter string) (result RoleAssignmentListResult, 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(filter string, cancel <-chan struct{}) (<-chan RoleAssignment, <-chan error)

ListComplete gets all elements from the list without paging.

func (RoleAssignmentsClient) ListForResource 

func (client RoleAssignmentsClient) ListForResource(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result RoleAssignmentListResult, 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(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string, cancel <-chan struct{}) (<-chan RoleAssignment, <-chan error)

ListForResourceComplete gets all elements from the list without paging.

func (RoleAssignmentsClient) ListForResourceGroup 

func (client RoleAssignmentsClient) ListForResourceGroup(resourceGroupName string, filter string) (result RoleAssignmentListResult, 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(resourceGroupName string, filter string, cancel <-chan struct{}) (<-chan RoleAssignment, <-chan error)

ListForResourceGroupComplete gets all elements from the list without paging.

func (RoleAssignmentsClient) ListForResourceGroupNextResults 

func (client RoleAssignmentsClient) ListForResourceGroupNextResults(lastResults RoleAssignmentListResult) (result RoleAssignmentListResult, err error)

ListForResourceGroupNextResults retrieves the next set of results, if any.

func (RoleAssignmentsClient) ListForResourceGroupPreparer 

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

func (client RoleAssignmentsClient) ListForResourceNextResults(lastResults RoleAssignmentListResult) (result RoleAssignmentListResult, err error)

ListForResourceNextResults retrieves the next set of results, if any.

func (RoleAssignmentsClient) ListForResourcePreparer 

func (client RoleAssignmentsClient) ListForResourcePreparer(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(scope string, filter string) (result RoleAssignmentListResult, 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(scope string, filter string, cancel <-chan struct{}) (<-chan RoleAssignment, <-chan error)

ListForScopeComplete gets all elements from the list without paging.

func (RoleAssignmentsClient) ListForScopeNextResults 

func (client RoleAssignmentsClient) ListForScopeNextResults(lastResults RoleAssignmentListResult) (result RoleAssignmentListResult, err error)

ListForScopeNextResults retrieves the next set of results, if any.

func (RoleAssignmentsClient) ListForScopePreparer 

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

func (client RoleAssignmentsClient) ListNextResults(lastResults RoleAssignmentListResult) (result RoleAssignmentListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (RoleAssignmentsClient) ListPreparer 

func (client RoleAssignmentsClient) ListPreparer(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                *string                   `json:"id,omitempty"`
	Name              *string                   `json:"name,omitempty"`
	Type              *string                   `json:"type,omitempty"`
	Properties        *RoleDefinitionProperties `json:"properties,omitempty"`
}

RoleDefinition is role definition.

type RoleDefinitionFilter 

type RoleDefinitionFilter struct {
	RoleName *string `json:"roleName,omitempty"`
}

RoleDefinitionFilter is role Definitions filter

type RoleDefinitionListResult 

type RoleDefinitionListResult struct {
	autorest.Response `json:"-"`
	Value             *[]RoleDefinition `json:"value,omitempty"`
	NextLink          *string           `json:"nextLink,omitempty"`
}

RoleDefinitionListResult is role definition list operation result.

func (RoleDefinitionListResult) RoleDefinitionListResultPreparer 

func (client RoleDefinitionListResult) RoleDefinitionListResultPreparer() (*http.Request, error)

RoleDefinitionListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type RoleDefinitionProperties 

type RoleDefinitionProperties struct {
	RoleName         *string       `json:"roleName,omitempty"`
	Description      *string       `json:"description,omitempty"`
	Type             *string       `json:"type,omitempty"`
	Permissions      *[]Permission `json:"permissions,omitempty"`
	AssignableScopes *[]string     `json:"assignableScopes,omitempty"`
}

RoleDefinitionProperties is role definition properties.

type RoleDefinitionsClient 

type RoleDefinitionsClient struct {
	ManagementClient
}

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(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(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(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(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(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(roleDefinitionID string) (result RoleDefinition, err error)

GetByID gets a role definition by ID.

roleDefinitionID is the fully qualified role definition ID to get.

func (RoleDefinitionsClient) GetByIDPreparer 

func (client RoleDefinitionsClient) GetByIDPreparer(roleDefinitionID 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(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(scope string, filter string) (result RoleDefinitionListResult, 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(scope string, filter string, cancel <-chan struct{}) (<-chan RoleDefinition, <-chan error)

ListComplete gets all elements from the list without paging.

func (RoleDefinitionsClient) ListNextResults 

func (client RoleDefinitionsClient) ListNextResults(lastResults RoleDefinitionListResult) (result RoleDefinitionListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (RoleDefinitionsClient) ListPreparer 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.