groups

Documentation

Overview

Package groups implements the Azure ARM Groups service API version 0.1.0.

Databricks REST API

Index

• Constants
• func UserAgent() string
• func Version() string
• type Attributes
• type BaseClient
  • func New() BaseClient
  • func NewWithBaseURI(baseURI string) BaseClient
  • func (client BaseClient) AddMember(ctx context.Context, body MemberAttributes) (result autorest.Response, err error)
  • func (client BaseClient) AddMemberPreparer(ctx context.Context, body MemberAttributes) (*http.Request, error)
  • func (client BaseClient) AddMemberResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client BaseClient) AddMemberSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) Create(ctx context.Context, body Attributes) (result CreateResult, err error)
  • func (client BaseClient) CreatePreparer(ctx context.Context, body Attributes) (*http.Request, error)
  • func (client BaseClient) CreateResponder(resp *http.Response) (result CreateResult, err error)
  • func (client BaseClient) CreateSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) Delete(ctx context.Context, body DeleteAttributes) (result autorest.Response, err error)
  • func (client BaseClient) DeletePreparer(ctx context.Context, body DeleteAttributes) (*http.Request, error)
  • func (client BaseClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client BaseClient) DeleteSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) List(ctx context.Context) (result ListResult, err error)
  • func (client BaseClient) ListMembers(ctx context.Context, groupName string) (result ListMembersResult, err error)
  • func (client BaseClient) ListMembersPreparer(ctx context.Context, groupName string) (*http.Request, error)
  • func (client BaseClient) ListMembersResponder(resp *http.Response) (result ListMembersResult, err error)
  • func (client BaseClient) ListMembersSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) ListParents(ctx context.Context, groupName string, userName string) (result ListResult, err error)
  • func (client BaseClient) ListParentsPreparer(ctx context.Context, groupName string, userName string) (*http.Request, error)
  • func (client BaseClient) ListParentsResponder(resp *http.Response) (result ListResult, err error)
  • func (client BaseClient) ListParentsSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) ListPreparer(ctx context.Context) (*http.Request, error)
  • func (client BaseClient) ListResponder(resp *http.Response) (result ListResult, err error)
  • func (client BaseClient) ListSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) RemoveMember(ctx context.Context, body MemberAttributes) (result autorest.Response, err error)
  • func (client BaseClient) RemoveMemberPreparer(ctx context.Context, body MemberAttributes) (*http.Request, error)
  • func (client BaseClient) RemoveMemberResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client BaseClient) RemoveMemberSender(req *http.Request) (*http.Response, error)
• type CreateResult
• type DeleteAttributes
• type ListMembersResult
• type ListResult
• type MemberAttributes
• type PrincipalName

Constants

const (
	// DefaultBaseURI is the default URI used for the service Groups
	DefaultBaseURI = "/api/2.0"
)

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 Attributes

type Attributes struct {
	GroupName *string `json:"group_name,omitempty"`
}

Attributes ...

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Groups.

func New

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string) BaseClient

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

func (BaseClient) AddMember

func (client BaseClient) AddMember(ctx context.Context, body MemberAttributes) (result autorest.Response, err error)

AddMember sends the add member request.

func (BaseClient) AddMemberPreparer

func (client BaseClient) AddMemberPreparer(ctx context.Context, body MemberAttributes) (*http.Request, error)

AddMemberPreparer prepares the AddMember request.

func (BaseClient) AddMemberResponder

func (client BaseClient) AddMemberResponder(resp *http.Response) (result autorest.Response, err error)

AddMemberResponder handles the response to the AddMember request. The method always closes the http.Response Body.

func (BaseClient) AddMemberSender

func (client BaseClient) AddMemberSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) Create

func (client BaseClient) Create(ctx context.Context, body Attributes) (result CreateResult, err error)

Create sends the create request.

func (BaseClient) CreatePreparer

func (client BaseClient) CreatePreparer(ctx context.Context, body Attributes) (*http.Request, error)

CreatePreparer prepares the Create request.

func (BaseClient) CreateResponder

func (client BaseClient) CreateResponder(resp *http.Response) (result CreateResult, err error)

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

func (BaseClient) CreateSender

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

func (client BaseClient) Delete(ctx context.Context, body DeleteAttributes) (result autorest.Response, err error)

Delete sends the delete request.

func (BaseClient) DeletePreparer

func (client BaseClient) DeletePreparer(ctx context.Context, body DeleteAttributes) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BaseClient) DeleteResponder

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

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

func (BaseClient) DeleteSender

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

func (client BaseClient) List(ctx context.Context) (result ListResult, err error)

List sends the list request.

func (BaseClient) ListMembers

func (client BaseClient) ListMembers(ctx context.Context, groupName string) (result ListMembersResult, err error)

ListMembers sends the list members request.

func (BaseClient) ListMembersPreparer

func (client BaseClient) ListMembersPreparer(ctx context.Context, groupName string) (*http.Request, error)

ListMembersPreparer prepares the ListMembers request.

func (BaseClient) ListMembersResponder

func (client BaseClient) ListMembersResponder(resp *http.Response) (result ListMembersResult, err error)

ListMembersResponder handles the response to the ListMembers request. The method always closes the http.Response Body.

func (BaseClient) ListMembersSender

func (client BaseClient) ListMembersSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) ListParents

func (client BaseClient) ListParents(ctx context.Context, groupName string, userName string) (result ListResult, err error)

ListParents sends the list parents request.

func (BaseClient) ListParentsPreparer

func (client BaseClient) ListParentsPreparer(ctx context.Context, groupName string, userName string) (*http.Request, error)

ListParentsPreparer prepares the ListParents request.

func (BaseClient) ListParentsResponder

func (client BaseClient) ListParentsResponder(resp *http.Response) (result ListResult, err error)

ListParentsResponder handles the response to the ListParents request. The method always closes the http.Response Body.

func (BaseClient) ListParentsSender

func (client BaseClient) ListParentsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) ListPreparer

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

ListPreparer prepares the List request.

func (BaseClient) ListResponder

func (client BaseClient) ListResponder(resp *http.Response) (result ListResult, err error)

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

func (BaseClient) ListSender

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

func (BaseClient) RemoveMember

func (client BaseClient) RemoveMember(ctx context.Context, body MemberAttributes) (result autorest.Response, err error)

RemoveMember sends the remove member request.

func (BaseClient) RemoveMemberPreparer

func (client BaseClient) RemoveMemberPreparer(ctx context.Context, body MemberAttributes) (*http.Request, error)

RemoveMemberPreparer prepares the RemoveMember request.

func (BaseClient) RemoveMemberResponder

func (client BaseClient) RemoveMemberResponder(resp *http.Response) (result autorest.Response, err error)

RemoveMemberResponder handles the response to the RemoveMember request. The method always closes the http.Response Body.

func (BaseClient) RemoveMemberSender

func (client BaseClient) RemoveMemberSender(req *http.Request) (*http.Response, error)

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

type CreateResult

type CreateResult struct {
	autorest.Response `json:"-"`
	GroupName         *string `json:"group_name,omitempty"`
}

CreateResult ...

type DeleteAttributes

type DeleteAttributes struct {
	GroupName *string `json:"group_name,omitempty"`
}

DeleteAttributes ...

type ListMembersResult

type ListMembersResult struct {
	autorest.Response `json:"-"`
	Members           *[]PrincipalName `json:"members,omitempty"`
}

ListMembersResult ...

type ListResult

type ListResult struct {
	autorest.Response `json:"-"`
	GroupNames        *[]string `json:"group_names,omitempty"`
}

ListResult ...

type MemberAttributes

type MemberAttributes struct {
	UserName   *string `json:"user_name,omitempty"`
	GroupName  *string `json:"group_name,omitempty"`
	ParentName *string `json:"parent_name,omitempty"`
}

MemberAttributes ...

type PrincipalName

type PrincipalName struct {
	UserName  *string `json:"user_name,omitempty"`
	GroupName *string `json:"group_name,omitempty"`
}

PrincipalName ...