synchronizationjobschema

README

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

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

Client Initialization

client := synchronizationjobschema.NewSynchronizationJobSchemaClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SynchronizationJobSchemaClient.DeleteSynchronizationJobSchema

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

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

Example Usage: SynchronizationJobSchemaClient.GetSynchronizationJobSchema

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

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

Example Usage: SynchronizationJobSchemaClient.ParseSynchronizationJobSchemaExpression

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

payload := synchronizationjobschema.ParseSynchronizationJobSchemaExpressionRequest{
	// ...
}


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

Example Usage: SynchronizationJobSchemaClient.UpdateSynchronizationJobSchema

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

payload := synchronizationjobschema.SynchronizationSchema{
	// ...
}


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

Documentation

Index

• type DeleteSynchronizationJobSchemaOperationOptions
  • func DefaultDeleteSynchronizationJobSchemaOperationOptions() DeleteSynchronizationJobSchemaOperationOptions
  • func (o DeleteSynchronizationJobSchemaOperationOptions) ToHeaders() *client.Headers
  • func (o DeleteSynchronizationJobSchemaOperationOptions) ToOData() *odata.Query
  • func (o DeleteSynchronizationJobSchemaOperationOptions) ToQuery() *client.QueryParams
• type DeleteSynchronizationJobSchemaOperationResponse
• type GetSynchronizationJobSchemaOperationOptions
  • func DefaultGetSynchronizationJobSchemaOperationOptions() GetSynchronizationJobSchemaOperationOptions
  • func (o GetSynchronizationJobSchemaOperationOptions) ToHeaders() *client.Headers
  • func (o GetSynchronizationJobSchemaOperationOptions) ToOData() *odata.Query
  • func (o GetSynchronizationJobSchemaOperationOptions) ToQuery() *client.QueryParams
• type GetSynchronizationJobSchemaOperationResponse
• type ParseSynchronizationJobSchemaExpressionOperationOptions
  • func DefaultParseSynchronizationJobSchemaExpressionOperationOptions() ParseSynchronizationJobSchemaExpressionOperationOptions
  • func (o ParseSynchronizationJobSchemaExpressionOperationOptions) ToHeaders() *client.Headers
  • func (o ParseSynchronizationJobSchemaExpressionOperationOptions) ToOData() *odata.Query
  • func (o ParseSynchronizationJobSchemaExpressionOperationOptions) ToQuery() *client.QueryParams
• type ParseSynchronizationJobSchemaExpressionOperationResponse
• type ParseSynchronizationJobSchemaExpressionRequest
• type SynchronizationJobSchemaClient
  • func NewSynchronizationJobSchemaClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationJobSchemaClient, error)
  • func (c SynchronizationJobSchemaClient) DeleteSynchronizationJobSchema(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, ...) (result DeleteSynchronizationJobSchemaOperationResponse, err error)
  • func (c SynchronizationJobSchemaClient) GetSynchronizationJobSchema(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, ...) (result GetSynchronizationJobSchemaOperationResponse, err error)
  • func (c SynchronizationJobSchemaClient) ParseSynchronizationJobSchemaExpression(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, ...) (result ParseSynchronizationJobSchemaExpressionOperationResponse, err error)
  • func (c SynchronizationJobSchemaClient) UpdateSynchronizationJobSchema(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, ...) (result UpdateSynchronizationJobSchemaOperationResponse, err error)
• type UpdateSynchronizationJobSchemaOperationOptions
  • func DefaultUpdateSynchronizationJobSchemaOperationOptions() UpdateSynchronizationJobSchemaOperationOptions
  • func (o UpdateSynchronizationJobSchemaOperationOptions) ToHeaders() *client.Headers
  • func (o UpdateSynchronizationJobSchemaOperationOptions) ToOData() *odata.Query
  • func (o UpdateSynchronizationJobSchemaOperationOptions) ToQuery() *client.QueryParams
• type UpdateSynchronizationJobSchemaOperationResponse

Types

type DeleteSynchronizationJobSchemaOperationOptions

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

func DefaultDeleteSynchronizationJobSchemaOperationOptions

func DefaultDeleteSynchronizationJobSchemaOperationOptions() DeleteSynchronizationJobSchemaOperationOptions

func (DeleteSynchronizationJobSchemaOperationOptions) ToHeaders

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

func (DeleteSynchronizationJobSchemaOperationOptions) ToOData

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

func (DeleteSynchronizationJobSchemaOperationOptions) ToQuery

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

type DeleteSynchronizationJobSchemaOperationResponse

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

type GetSynchronizationJobSchemaOperationOptions

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

func DefaultGetSynchronizationJobSchemaOperationOptions

func DefaultGetSynchronizationJobSchemaOperationOptions() GetSynchronizationJobSchemaOperationOptions

func (GetSynchronizationJobSchemaOperationOptions) ToHeaders

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

func (GetSynchronizationJobSchemaOperationOptions) ToOData

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

func (GetSynchronizationJobSchemaOperationOptions) ToQuery

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

type GetSynchronizationJobSchemaOperationResponse

type GetSynchronizationJobSchemaOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.SynchronizationSchema
}

type ParseSynchronizationJobSchemaExpressionOperationOptions

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

func DefaultParseSynchronizationJobSchemaExpressionOperationOptions

func DefaultParseSynchronizationJobSchemaExpressionOperationOptions() ParseSynchronizationJobSchemaExpressionOperationOptions

func (ParseSynchronizationJobSchemaExpressionOperationOptions) ToHeaders

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

func (ParseSynchronizationJobSchemaExpressionOperationOptions) ToOData

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

func (ParseSynchronizationJobSchemaExpressionOperationOptions) ToQuery

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

type ParseSynchronizationJobSchemaExpressionOperationResponse

type ParseSynchronizationJobSchemaExpressionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ParseExpressionResponse
}

type ParseSynchronizationJobSchemaExpressionRequest

type ParseSynchronizationJobSchemaExpressionRequest struct {
	Expression                nullable.Type[string]       `json:"expression,omitempty"`
	TargetAttributeDefinition *beta.AttributeDefinition   `json:"targetAttributeDefinition,omitempty"`
	TestInputObject           *beta.ExpressionInputObject `json:"testInputObject,omitempty"`
}

type SynchronizationJobSchemaClient

type SynchronizationJobSchemaClient struct {
	Client *msgraph.Client
}

func NewSynchronizationJobSchemaClientWithBaseURI

func NewSynchronizationJobSchemaClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationJobSchemaClient, error)

func (SynchronizationJobSchemaClient) DeleteSynchronizationJobSchema

func (c SynchronizationJobSchemaClient) DeleteSynchronizationJobSchema(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, options DeleteSynchronizationJobSchemaOperationOptions) (result DeleteSynchronizationJobSchemaOperationResponse, err error)

DeleteSynchronizationJobSchema - Delete navigation property schema for servicePrincipals

func (SynchronizationJobSchemaClient) GetSynchronizationJobSchema

func (c SynchronizationJobSchemaClient) GetSynchronizationJobSchema(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, options GetSynchronizationJobSchemaOperationOptions) (result GetSynchronizationJobSchemaOperationResponse, err error)

GetSynchronizationJobSchema - Get synchronizationSchema. Retrieve the schema for a given synchronization job or template.

func (SynchronizationJobSchemaClient) ParseSynchronizationJobSchemaExpression

func (c SynchronizationJobSchemaClient) ParseSynchronizationJobSchemaExpression(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, input ParseSynchronizationJobSchemaExpressionRequest, options ParseSynchronizationJobSchemaExpressionOperationOptions) (result ParseSynchronizationJobSchemaExpressionOperationResponse, err error)

ParseSynchronizationJobSchemaExpression - Invoke action parseExpression. Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.

func (SynchronizationJobSchemaClient) UpdateSynchronizationJobSchema

func (c SynchronizationJobSchemaClient) UpdateSynchronizationJobSchema(ctx context.Context, id beta.ServicePrincipalIdSynchronizationJobId, input beta.SynchronizationSchema, options UpdateSynchronizationJobSchemaOperationOptions) (result UpdateSynchronizationJobSchemaOperationResponse, err error)

UpdateSynchronizationJobSchema - Update synchronizationSchema. Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.

type UpdateSynchronizationJobSchemaOperationOptions

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

func DefaultUpdateSynchronizationJobSchemaOperationOptions

func DefaultUpdateSynchronizationJobSchemaOperationOptions() UpdateSynchronizationJobSchemaOperationOptions

func (UpdateSynchronizationJobSchemaOperationOptions) ToHeaders

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

func (UpdateSynchronizationJobSchemaOperationOptions) ToOData

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

func (UpdateSynchronizationJobSchemaOperationOptions) ToQuery

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

type UpdateSynchronizationJobSchemaOperationResponse

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