synchronizationsecret

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/serviceprincipals/stable/synchronizationsecret Documentation

The synchronizationsecret SDK allows for interaction with Microsoft Graph serviceprincipals (API Version stable).

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/stable/synchronizationsecret"

Client Initialization

client := synchronizationsecret.NewSynchronizationSecretClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SynchronizationSecretClient.GetSynchronizationSecretsCount

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

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

Example Usage: SynchronizationSecretClient.ListSynchronizationSecrets

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

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

Example Usage: SynchronizationSecretClient.SetSynchronizationSecret

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

payload := synchronizationsecret.SetSynchronizationSecretRequest{
	// ...
}


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

Documentation

Index

• type GetSynchronizationSecretsCountOperationOptions
  • func DefaultGetSynchronizationSecretsCountOperationOptions() GetSynchronizationSecretsCountOperationOptions
  • func (o GetSynchronizationSecretsCountOperationOptions) ToHeaders() *client.Headers
  • func (o GetSynchronizationSecretsCountOperationOptions) ToOData() *odata.Query
  • func (o GetSynchronizationSecretsCountOperationOptions) ToQuery() *client.QueryParams
• type GetSynchronizationSecretsCountOperationResponse
• type ListSynchronizationSecretsCompleteResult
• type ListSynchronizationSecretsCustomPager
  • func (p *ListSynchronizationSecretsCustomPager) NextPageLink() *odata.Link
• type ListSynchronizationSecretsOperationOptions
  • func DefaultListSynchronizationSecretsOperationOptions() ListSynchronizationSecretsOperationOptions
  • func (o ListSynchronizationSecretsOperationOptions) ToHeaders() *client.Headers
  • func (o ListSynchronizationSecretsOperationOptions) ToOData() *odata.Query
  • func (o ListSynchronizationSecretsOperationOptions) ToQuery() *client.QueryParams
• type ListSynchronizationSecretsOperationResponse
• type SetSynchronizationSecretOperationOptions
  • func DefaultSetSynchronizationSecretOperationOptions() SetSynchronizationSecretOperationOptions
  • func (o SetSynchronizationSecretOperationOptions) ToHeaders() *client.Headers
  • func (o SetSynchronizationSecretOperationOptions) ToOData() *odata.Query
  • func (o SetSynchronizationSecretOperationOptions) ToQuery() *client.QueryParams
• type SetSynchronizationSecretOperationResponse
• type SetSynchronizationSecretRequest
• type SynchronizationSecretClient
  • func NewSynchronizationSecretClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationSecretClient, error)
  • func (c SynchronizationSecretClient) GetSynchronizationSecretsCount(ctx context.Context, id stable.ServicePrincipalId, ...) (result GetSynchronizationSecretsCountOperationResponse, err error)
  • func (c SynchronizationSecretClient) ListSynchronizationSecrets(ctx context.Context, id stable.ServicePrincipalId, ...) (result ListSynchronizationSecretsOperationResponse, err error)
  • func (c SynchronizationSecretClient) ListSynchronizationSecretsComplete(ctx context.Context, id stable.ServicePrincipalId, ...) (ListSynchronizationSecretsCompleteResult, error)
  • func (c SynchronizationSecretClient) ListSynchronizationSecretsCompleteMatchingPredicate(ctx context.Context, id stable.ServicePrincipalId, ...) (result ListSynchronizationSecretsCompleteResult, err error)
  • func (c SynchronizationSecretClient) SetSynchronizationSecret(ctx context.Context, id stable.ServicePrincipalId, ...) (result SetSynchronizationSecretOperationResponse, err error)
• type SynchronizationSecretKeyStringValuePairOperationPredicate
  • func (p SynchronizationSecretKeyStringValuePairOperationPredicate) Matches(input stable.SynchronizationSecretKeyStringValuePair) bool

Types

type GetSynchronizationSecretsCountOperationOptions

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

func DefaultGetSynchronizationSecretsCountOperationOptions

func DefaultGetSynchronizationSecretsCountOperationOptions() GetSynchronizationSecretsCountOperationOptions

func (GetSynchronizationSecretsCountOperationOptions) ToHeaders

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

func (GetSynchronizationSecretsCountOperationOptions) ToOData

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

func (GetSynchronizationSecretsCountOperationOptions) ToQuery

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

type GetSynchronizationSecretsCountOperationResponse

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

type ListSynchronizationSecretsCompleteResult

type ListSynchronizationSecretsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.SynchronizationSecretKeyStringValuePair
}

type ListSynchronizationSecretsCustomPager

type ListSynchronizationSecretsCustomPager struct {
	NextLink *odata.Link `json:"@odata.nextLink"`
}

func (*ListSynchronizationSecretsCustomPager) NextPageLink

func (p *ListSynchronizationSecretsCustomPager) NextPageLink() *odata.Link

type ListSynchronizationSecretsOperationOptions

type ListSynchronizationSecretsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultListSynchronizationSecretsOperationOptions

func DefaultListSynchronizationSecretsOperationOptions() ListSynchronizationSecretsOperationOptions

func (ListSynchronizationSecretsOperationOptions) ToHeaders

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

func (ListSynchronizationSecretsOperationOptions) ToOData

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

func (ListSynchronizationSecretsOperationOptions) ToQuery

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

type ListSynchronizationSecretsOperationResponse

type ListSynchronizationSecretsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.SynchronizationSecretKeyStringValuePair
}

type SetSynchronizationSecretOperationOptions

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

func DefaultSetSynchronizationSecretOperationOptions

func DefaultSetSynchronizationSecretOperationOptions() SetSynchronizationSecretOperationOptions

func (SetSynchronizationSecretOperationOptions) ToHeaders

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

func (SetSynchronizationSecretOperationOptions) ToOData

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

func (SetSynchronizationSecretOperationOptions) ToQuery

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

type SetSynchronizationSecretOperationResponse

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

type SetSynchronizationSecretRequest

type SetSynchronizationSecretRequest struct {
	Value *[]stable.SynchronizationSecretKeyStringValuePair `json:"value,omitempty"`
}

type SynchronizationSecretClient

type SynchronizationSecretClient struct {
	Client *msgraph.Client
}

func NewSynchronizationSecretClientWithBaseURI

func NewSynchronizationSecretClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationSecretClient, error)

func (SynchronizationSecretClient) GetSynchronizationSecretsCount

func (c SynchronizationSecretClient) GetSynchronizationSecretsCount(ctx context.Context, id stable.ServicePrincipalId, options GetSynchronizationSecretsCountOperationOptions) (result GetSynchronizationSecretsCountOperationResponse, err error)

GetSynchronizationSecretsCount - Get the number of the resource

func (SynchronizationSecretClient) ListSynchronizationSecrets

func (c SynchronizationSecretClient) ListSynchronizationSecrets(ctx context.Context, id stable.ServicePrincipalId, options ListSynchronizationSecretsOperationOptions) (result ListSynchronizationSecretsOperationResponse, err error)

ListSynchronizationSecrets - Retrieve synchronization secrets.

func (SynchronizationSecretClient) ListSynchronizationSecretsComplete

func (c SynchronizationSecretClient) ListSynchronizationSecretsComplete(ctx context.Context, id stable.ServicePrincipalId, options ListSynchronizationSecretsOperationOptions) (ListSynchronizationSecretsCompleteResult, error)

ListSynchronizationSecretsComplete retrieves all the results into a single object

func (SynchronizationSecretClient) ListSynchronizationSecretsCompleteMatchingPredicate

func (c SynchronizationSecretClient) ListSynchronizationSecretsCompleteMatchingPredicate(ctx context.Context, id stable.ServicePrincipalId, options ListSynchronizationSecretsOperationOptions, predicate SynchronizationSecretKeyStringValuePairOperationPredicate) (result ListSynchronizationSecretsCompleteResult, err error)

ListSynchronizationSecretsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SynchronizationSecretClient) SetSynchronizationSecret

func (c SynchronizationSecretClient) SetSynchronizationSecret(ctx context.Context, id stable.ServicePrincipalId, input SetSynchronizationSecretRequest, options SetSynchronizationSecretOperationOptions) (result SetSynchronizationSecretOperationResponse, err error)

SetSynchronizationSecret - Add synchronization secrets. Provide credentials for establishing connectivity with the target system.

type SynchronizationSecretKeyStringValuePairOperationPredicate

type SynchronizationSecretKeyStringValuePairOperationPredicate struct {
}

func (SynchronizationSecretKeyStringValuePairOperationPredicate) Matches

func (p SynchronizationSecretKeyStringValuePairOperationPredicate) Matches(input stable.SynchronizationSecretKeyStringValuePair) bool