synchronization

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/serviceprincipals/beta/synchronization Documentation

The synchronization SDK allows for interaction with Microsoft Graph serviceprincipals (API Version beta).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/microsoft-graph/serviceprincipals/beta/synchronization"

Client Initialization

client := synchronization.NewSynchronizationClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SynchronizationClient.AcquireSynchronizationAccessToken

ctx := context.TODO()
id := synchronization.NewServicePrincipalID("servicePrincipalId")

payload := synchronization.AcquireSynchronizationAccessTokenRequest{
	// ...
}


read, err := client.AcquireSynchronizationAccessToken(ctx, id, payload, synchronization.DefaultAcquireSynchronizationAccessTokenOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SynchronizationClient.DeleteSynchronization

ctx := context.TODO()
id := synchronization.NewServicePrincipalID("servicePrincipalId")

read, err := client.DeleteSynchronization(ctx, id, synchronization.DefaultDeleteSynchronizationOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SynchronizationClient.GetSynchronization

ctx := context.TODO()
id := synchronization.NewServicePrincipalID("servicePrincipalId")

read, err := client.GetSynchronization(ctx, id, synchronization.DefaultGetSynchronizationOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SynchronizationClient.SetSynchronization

ctx := context.TODO()
id := synchronization.NewServicePrincipalID("servicePrincipalId")

payload := synchronization.Synchronization{
	// ...
}


read, err := client.SetSynchronization(ctx, id, payload, synchronization.DefaultSetSynchronizationOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• type AcquireSynchronizationAccessTokenOperationOptions
  • func DefaultAcquireSynchronizationAccessTokenOperationOptions() AcquireSynchronizationAccessTokenOperationOptions
  • func (o AcquireSynchronizationAccessTokenOperationOptions) ToHeaders() *client.Headers
  • func (o AcquireSynchronizationAccessTokenOperationOptions) ToOData() *odata.Query
  • func (o AcquireSynchronizationAccessTokenOperationOptions) ToQuery() *client.QueryParams
• type AcquireSynchronizationAccessTokenOperationResponse
• type AcquireSynchronizationAccessTokenRequest
• type DeleteSynchronizationOperationOptions
  • func DefaultDeleteSynchronizationOperationOptions() DeleteSynchronizationOperationOptions
  • func (o DeleteSynchronizationOperationOptions) ToHeaders() *client.Headers
  • func (o DeleteSynchronizationOperationOptions) ToOData() *odata.Query
  • func (o DeleteSynchronizationOperationOptions) ToQuery() *client.QueryParams
• type DeleteSynchronizationOperationResponse
• type GetSynchronizationOperationOptions
  • func DefaultGetSynchronizationOperationOptions() GetSynchronizationOperationOptions
  • func (o GetSynchronizationOperationOptions) ToHeaders() *client.Headers
  • func (o GetSynchronizationOperationOptions) ToOData() *odata.Query
  • func (o GetSynchronizationOperationOptions) ToQuery() *client.QueryParams
• type GetSynchronizationOperationResponse
• type SetSynchronizationOperationOptions
  • func DefaultSetSynchronizationOperationOptions() SetSynchronizationOperationOptions
  • func (o SetSynchronizationOperationOptions) ToHeaders() *client.Headers
  • func (o SetSynchronizationOperationOptions) ToOData() *odata.Query
  • func (o SetSynchronizationOperationOptions) ToQuery() *client.QueryParams
• type SetSynchronizationOperationResponse
• type SynchronizationClient
  • func NewSynchronizationClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationClient, error)
  • func (c SynchronizationClient) AcquireSynchronizationAccessToken(ctx context.Context, id beta.ServicePrincipalId, ...) (result AcquireSynchronizationAccessTokenOperationResponse, err error)
  • func (c SynchronizationClient) DeleteSynchronization(ctx context.Context, id beta.ServicePrincipalId, ...) (result DeleteSynchronizationOperationResponse, err error)
  • func (c SynchronizationClient) GetSynchronization(ctx context.Context, id beta.ServicePrincipalId, ...) (result GetSynchronizationOperationResponse, err error)
  • func (c SynchronizationClient) SetSynchronization(ctx context.Context, id beta.ServicePrincipalId, input beta.Synchronization, ...) (result SetSynchronizationOperationResponse, err error)

Types

type AcquireSynchronizationAccessTokenOperationOptions

type AcquireSynchronizationAccessTokenOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultAcquireSynchronizationAccessTokenOperationOptions

func DefaultAcquireSynchronizationAccessTokenOperationOptions() AcquireSynchronizationAccessTokenOperationOptions

func (AcquireSynchronizationAccessTokenOperationOptions) ToHeaders

func (o AcquireSynchronizationAccessTokenOperationOptions) ToHeaders() *client.Headers

func (AcquireSynchronizationAccessTokenOperationOptions) ToOData

func (o AcquireSynchronizationAccessTokenOperationOptions) ToOData() *odata.Query

func (AcquireSynchronizationAccessTokenOperationOptions) ToQuery

func (o AcquireSynchronizationAccessTokenOperationOptions) ToQuery() *client.QueryParams

type AcquireSynchronizationAccessTokenOperationResponse

type AcquireSynchronizationAccessTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type AcquireSynchronizationAccessTokenRequest

type AcquireSynchronizationAccessTokenRequest struct {
	Credentials *[]beta.SynchronizationSecretKeyStringValuePair `json:"credentials,omitempty"`
}

type DeleteSynchronizationOperationOptions

type DeleteSynchronizationOperationOptions struct {
	IfMatch   *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeleteSynchronizationOperationOptions

func DefaultDeleteSynchronizationOperationOptions() DeleteSynchronizationOperationOptions

func (DeleteSynchronizationOperationOptions) ToHeaders

func (o DeleteSynchronizationOperationOptions) ToHeaders() *client.Headers

func (DeleteSynchronizationOperationOptions) ToOData

func (o DeleteSynchronizationOperationOptions) ToOData() *odata.Query

func (DeleteSynchronizationOperationOptions) ToQuery

func (o DeleteSynchronizationOperationOptions) ToQuery() *client.QueryParams

type DeleteSynchronizationOperationResponse

type DeleteSynchronizationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetSynchronizationOperationOptions

type GetSynchronizationOperationOptions struct {
	Expand    *odata.Expand
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Select    *[]string
}

func DefaultGetSynchronizationOperationOptions

func DefaultGetSynchronizationOperationOptions() GetSynchronizationOperationOptions

func (GetSynchronizationOperationOptions) ToHeaders

func (o GetSynchronizationOperationOptions) ToHeaders() *client.Headers

func (GetSynchronizationOperationOptions) ToOData

func (o GetSynchronizationOperationOptions) ToOData() *odata.Query

func (GetSynchronizationOperationOptions) ToQuery

func (o GetSynchronizationOperationOptions) ToQuery() *client.QueryParams

type GetSynchronizationOperationResponse

type GetSynchronizationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Synchronization
}

type SetSynchronizationOperationOptions

type SetSynchronizationOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultSetSynchronizationOperationOptions

func DefaultSetSynchronizationOperationOptions() SetSynchronizationOperationOptions

func (SetSynchronizationOperationOptions) ToHeaders

func (o SetSynchronizationOperationOptions) ToHeaders() *client.Headers

func (SetSynchronizationOperationOptions) ToOData

func (o SetSynchronizationOperationOptions) ToOData() *odata.Query

func (SetSynchronizationOperationOptions) ToQuery

func (o SetSynchronizationOperationOptions) ToQuery() *client.QueryParams

type SetSynchronizationOperationResponse

type SetSynchronizationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type SynchronizationClient

type SynchronizationClient struct {
	Client *msgraph.Client
}

func NewSynchronizationClientWithBaseURI

func NewSynchronizationClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationClient, error)

func (SynchronizationClient) AcquireSynchronizationAccessToken

func (c SynchronizationClient) AcquireSynchronizationAccessToken(ctx context.Context, id beta.ServicePrincipalId, input AcquireSynchronizationAccessTokenRequest, options AcquireSynchronizationAccessTokenOperationOptions) (result AcquireSynchronizationAccessTokenOperationResponse, err error)

AcquireSynchronizationAccessToken - Invoke action acquireAccessToken. Acquire an OAuth Access token to authorize the Microsoft Entra provisioning service to provision users into an application.

func (SynchronizationClient) DeleteSynchronization

func (c SynchronizationClient) DeleteSynchronization(ctx context.Context, id beta.ServicePrincipalId, options DeleteSynchronizationOperationOptions) (result DeleteSynchronizationOperationResponse, err error)

DeleteSynchronization - Delete navigation property synchronization for servicePrincipals

func (SynchronizationClient) GetSynchronization

func (c SynchronizationClient) GetSynchronization(ctx context.Context, id beta.ServicePrincipalId, options GetSynchronizationOperationOptions) (result GetSynchronizationOperationResponse, err error)

GetSynchronization - Get synchronization from servicePrincipals. Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API.

func (SynchronizationClient) SetSynchronization

func (c SynchronizationClient) SetSynchronization(ctx context.Context, id beta.ServicePrincipalId, input beta.Synchronization, options SetSynchronizationOperationOptions) (result SetSynchronizationOperationResponse, err error)

SetSynchronization - Update the navigation property synchronization in servicePrincipals