synchronizationjob

package
v0.20241104.1140654 Latest Latest
Warning

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

Go to latest
Published: Nov 4, 2024 License: MPL-2.0 Imports: 9 Imported by: 0

README

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

The synchronizationjob 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/synchronizationjob"

Client Initialization

client := synchronizationjob.NewSynchronizationJobClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SynchronizationJobClient.CreateSynchronizationJob

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

payload := synchronizationjob.SynchronizationJob{
	// ...
}


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

Example Usage: SynchronizationJobClient.DeleteSynchronizationJob

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

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

Example Usage: SynchronizationJobClient.GetSynchronizationJob

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

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

Example Usage: SynchronizationJobClient.GetSynchronizationJobsCount

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

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

Example Usage: SynchronizationJobClient.ListSynchronizationJobs

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

// alternatively `client.ListSynchronizationJobs(ctx, id, synchronizationjob.DefaultListSynchronizationJobsOperationOptions())` can be used to do batched pagination
items, err := client.ListSynchronizationJobsComplete(ctx, id, synchronizationjob.DefaultListSynchronizationJobsOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: SynchronizationJobClient.PauseSynchronizationJob

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

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

Example Usage: SynchronizationJobClient.ProvisionSynchronizationJobOnDemand

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

payload := synchronizationjob.ProvisionSynchronizationJobOnDemandRequest{
	// ...
}


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

Example Usage: SynchronizationJobClient.RestartSynchronizationJob

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

payload := synchronizationjob.RestartSynchronizationJobRequest{
	// ...
}


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

Example Usage: SynchronizationJobClient.StartSynchronizationJob

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

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

Example Usage: SynchronizationJobClient.UpdateSynchronizationJob

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

payload := synchronizationjob.SynchronizationJob{
	// ...
}


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

Example Usage: SynchronizationJobClient.ValidateSynchronizationJobCredentials

ctx := context.TODO()
id := synchronizationjob.NewServicePrincipalIdSynchronizationJobID("servicePrincipalId", "synchronizationJobId")

payload := synchronizationjob.ValidateSynchronizationJobCredentialsRequest{
	// ...
}


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

Example Usage: SynchronizationJobClient.ValidateSynchronizationJobsCredentials

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

payload := synchronizationjob.ValidateSynchronizationJobsCredentialsRequest{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateSynchronizationJobOperationOptions

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

func DefaultCreateSynchronizationJobOperationOptions

func DefaultCreateSynchronizationJobOperationOptions() CreateSynchronizationJobOperationOptions

func (CreateSynchronizationJobOperationOptions) ToHeaders

func (CreateSynchronizationJobOperationOptions) ToOData

func (CreateSynchronizationJobOperationOptions) ToQuery

type CreateSynchronizationJobOperationResponse

type CreateSynchronizationJobOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.SynchronizationJob
}

type DeleteSynchronizationJobOperationOptions

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

func DefaultDeleteSynchronizationJobOperationOptions

func DefaultDeleteSynchronizationJobOperationOptions() DeleteSynchronizationJobOperationOptions

func (DeleteSynchronizationJobOperationOptions) ToHeaders

func (DeleteSynchronizationJobOperationOptions) ToOData

func (DeleteSynchronizationJobOperationOptions) ToQuery

type DeleteSynchronizationJobOperationResponse

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

type GetSynchronizationJobOperationOptions

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

func DefaultGetSynchronizationJobOperationOptions

func DefaultGetSynchronizationJobOperationOptions() GetSynchronizationJobOperationOptions

func (GetSynchronizationJobOperationOptions) ToHeaders

func (GetSynchronizationJobOperationOptions) ToOData

func (GetSynchronizationJobOperationOptions) ToQuery

type GetSynchronizationJobOperationResponse

type GetSynchronizationJobOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.SynchronizationJob
}

type GetSynchronizationJobsCountOperationOptions

type GetSynchronizationJobsCountOperationOptions struct {
	Filter    *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Search    *string
}

func DefaultGetSynchronizationJobsCountOperationOptions

func DefaultGetSynchronizationJobsCountOperationOptions() GetSynchronizationJobsCountOperationOptions

func (GetSynchronizationJobsCountOperationOptions) ToHeaders

func (GetSynchronizationJobsCountOperationOptions) ToOData

func (GetSynchronizationJobsCountOperationOptions) ToQuery

type GetSynchronizationJobsCountOperationResponse

type GetSynchronizationJobsCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListSynchronizationJobsCompleteResult

type ListSynchronizationJobsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.SynchronizationJob
}

type ListSynchronizationJobsCustomPager

type ListSynchronizationJobsCustomPager struct {
	NextLink *odata.Link `json:"@odata.nextLink"`
}
func (p *ListSynchronizationJobsCustomPager) NextPageLink() *odata.Link

type ListSynchronizationJobsOperationOptions

type ListSynchronizationJobsOperationOptions struct {
	Count     *bool
	Expand    *odata.Expand
	Filter    *string
	Metadata  *odata.Metadata
	OrderBy   *odata.OrderBy
	RetryFunc client.RequestRetryFunc
	Search    *string
	Select    *[]string
	Skip      *int64
	Top       *int64
}

func DefaultListSynchronizationJobsOperationOptions

func DefaultListSynchronizationJobsOperationOptions() ListSynchronizationJobsOperationOptions

func (ListSynchronizationJobsOperationOptions) ToHeaders

func (ListSynchronizationJobsOperationOptions) ToOData

func (ListSynchronizationJobsOperationOptions) ToQuery

type ListSynchronizationJobsOperationResponse

type ListSynchronizationJobsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.SynchronizationJob
}

type PauseSynchronizationJobOperationOptions

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

func DefaultPauseSynchronizationJobOperationOptions

func DefaultPauseSynchronizationJobOperationOptions() PauseSynchronizationJobOperationOptions

func (PauseSynchronizationJobOperationOptions) ToHeaders

func (PauseSynchronizationJobOperationOptions) ToOData

func (PauseSynchronizationJobOperationOptions) ToQuery

type PauseSynchronizationJobOperationResponse

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

type ProvisionSynchronizationJobOnDemandOperationOptions

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

func DefaultProvisionSynchronizationJobOnDemandOperationOptions

func DefaultProvisionSynchronizationJobOnDemandOperationOptions() ProvisionSynchronizationJobOnDemandOperationOptions

func (ProvisionSynchronizationJobOnDemandOperationOptions) ToHeaders

func (ProvisionSynchronizationJobOnDemandOperationOptions) ToOData

func (ProvisionSynchronizationJobOnDemandOperationOptions) ToQuery

type ProvisionSynchronizationJobOnDemandOperationResponse

type ProvisionSynchronizationJobOnDemandOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.StringKeyStringValuePair
}

type ProvisionSynchronizationJobOnDemandRequest

type ProvisionSynchronizationJobOnDemandRequest struct {
	Parameters *[]beta.SynchronizationJobApplicationParameters `json:"parameters,omitempty"`
}

type RestartSynchronizationJobOperationOptions

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

func DefaultRestartSynchronizationJobOperationOptions

func DefaultRestartSynchronizationJobOperationOptions() RestartSynchronizationJobOperationOptions

func (RestartSynchronizationJobOperationOptions) ToHeaders

func (RestartSynchronizationJobOperationOptions) ToOData

func (RestartSynchronizationJobOperationOptions) ToQuery

type RestartSynchronizationJobOperationResponse

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

type RestartSynchronizationJobRequest

type RestartSynchronizationJobRequest struct {
	Criteria *beta.SynchronizationJobRestartCriteria `json:"criteria,omitempty"`
}

type StartSynchronizationJobOperationOptions

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

func DefaultStartSynchronizationJobOperationOptions

func DefaultStartSynchronizationJobOperationOptions() StartSynchronizationJobOperationOptions

func (StartSynchronizationJobOperationOptions) ToHeaders

func (StartSynchronizationJobOperationOptions) ToOData

func (StartSynchronizationJobOperationOptions) ToQuery

type StartSynchronizationJobOperationResponse

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

type SynchronizationJobClient

type SynchronizationJobClient struct {
	Client *msgraph.Client
}

func NewSynchronizationJobClientWithBaseURI

func NewSynchronizationJobClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationJobClient, error)

func (SynchronizationJobClient) CreateSynchronizationJob

CreateSynchronizationJob - Create synchronizationJob. Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization.

func (SynchronizationJobClient) DeleteSynchronizationJob

DeleteSynchronizationJob - Delete synchronizationJob. Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is.

func (SynchronizationJobClient) GetSynchronizationJob

GetSynchronizationJob - Get synchronizationJob. Retrieve the existing synchronization job and its properties.

func (SynchronizationJobClient) GetSynchronizationJobsCount

GetSynchronizationJobsCount - Get the number of the resource

func (SynchronizationJobClient) ListSynchronizationJobs

ListSynchronizationJobs - List synchronization jobs. List existing jobs for a given application instance (service principal).

func (SynchronizationJobClient) ListSynchronizationJobsComplete

ListSynchronizationJobsComplete retrieves all the results into a single object

func (SynchronizationJobClient) ListSynchronizationJobsCompleteMatchingPredicate

ListSynchronizationJobsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SynchronizationJobClient) PauseSynchronizationJob

PauseSynchronizationJob - Invoke action pause. Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job continues from where it left off when a start call is made.

func (SynchronizationJobClient) ProvisionSynchronizationJobOnDemand

ProvisionSynchronizationJobOnDemand - Invoke action provisionOnDemand. Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. No user or group will be provisioned on-demand that would not have been provisioned through the regular provisioning cycles.

func (SynchronizationJobClient) RestartSynchronizationJob

RestartSynchronizationJob - Invoke action restart. Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.

func (SynchronizationJobClient) StartSynchronizationJob

StartSynchronizationJob - Invoke action start. Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don't create scripts to call the start job continuously while it's running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine.

func (SynchronizationJobClient) UpdateSynchronizationJob

UpdateSynchronizationJob - Update the navigation property jobs in servicePrincipals

func (SynchronizationJobClient) ValidateSynchronizationJobCredentials

ValidateSynchronizationJobCredentials - Invoke action validateCredentials. Validate that the credentials are valid in the tenant.

func (SynchronizationJobClient) ValidateSynchronizationJobsCredentials

ValidateSynchronizationJobsCredentials - Invoke action validateCredentials

type SynchronizationJobOperationPredicate

type SynchronizationJobOperationPredicate struct {
}

func (SynchronizationJobOperationPredicate) Matches

type UpdateSynchronizationJobOperationOptions

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

func DefaultUpdateSynchronizationJobOperationOptions

func DefaultUpdateSynchronizationJobOperationOptions() UpdateSynchronizationJobOperationOptions

func (UpdateSynchronizationJobOperationOptions) ToHeaders

func (UpdateSynchronizationJobOperationOptions) ToOData

func (UpdateSynchronizationJobOperationOptions) ToQuery

type UpdateSynchronizationJobOperationResponse

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

type ValidateSynchronizationJobCredentialsOperationOptions

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

func DefaultValidateSynchronizationJobCredentialsOperationOptions

func DefaultValidateSynchronizationJobCredentialsOperationOptions() ValidateSynchronizationJobCredentialsOperationOptions

func (ValidateSynchronizationJobCredentialsOperationOptions) ToHeaders

func (ValidateSynchronizationJobCredentialsOperationOptions) ToOData

func (ValidateSynchronizationJobCredentialsOperationOptions) ToQuery

type ValidateSynchronizationJobCredentialsOperationResponse

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

type ValidateSynchronizationJobCredentialsRequest

type ValidateSynchronizationJobCredentialsRequest struct {
	ApplicationIdentifier nullable.Type[string]                           `json:"applicationIdentifier,omitempty"`
	Credentials           *[]beta.SynchronizationSecretKeyStringValuePair `json:"credentials,omitempty"`
	TemplateId            nullable.Type[string]                           `json:"templateId,omitempty"`
	UseSavedCredentials   nullable.Type[bool]                             `json:"useSavedCredentials,omitempty"`
}

type ValidateSynchronizationJobsCredentialsOperationOptions

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

func DefaultValidateSynchronizationJobsCredentialsOperationOptions

func DefaultValidateSynchronizationJobsCredentialsOperationOptions() ValidateSynchronizationJobsCredentialsOperationOptions

func (ValidateSynchronizationJobsCredentialsOperationOptions) ToHeaders

func (ValidateSynchronizationJobsCredentialsOperationOptions) ToOData

func (ValidateSynchronizationJobsCredentialsOperationOptions) ToQuery

type ValidateSynchronizationJobsCredentialsOperationResponse

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

type ValidateSynchronizationJobsCredentialsRequest

type ValidateSynchronizationJobsCredentialsRequest struct {
	ApplicationIdentifier nullable.Type[string]                           `json:"applicationIdentifier,omitempty"`
	Credentials           *[]beta.SynchronizationSecretKeyStringValuePair `json:"credentials,omitempty"`
	TemplateId            nullable.Type[string]                           `json:"templateId,omitempty"`
	UseSavedCredentials   nullable.Type[bool]                             `json:"useSavedCredentials,omitempty"`
}

Jump to

Keyboard shortcuts

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