customauthenticationextension

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/identity/stable/customauthenticationextension Documentation

The customauthenticationextension SDK allows for interaction with Microsoft Graph identity (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/identity/stable/customauthenticationextension"

Client Initialization

client := customauthenticationextension.NewCustomAuthenticationExtensionClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: CustomAuthenticationExtensionClient.CreateCustomAuthenticationExtension

ctx := context.TODO()

payload := customauthenticationextension.CustomAuthenticationExtension{
	// ...
}


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

Example Usage: CustomAuthenticationExtensionClient.DeleteCustomAuthenticationExtension

ctx := context.TODO()
id := customauthenticationextension.NewIdentityCustomAuthenticationExtensionID("customAuthenticationExtensionId")

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

Example Usage: CustomAuthenticationExtensionClient.GetCustomAuthenticationExtension

ctx := context.TODO()
id := customauthenticationextension.NewIdentityCustomAuthenticationExtensionID("customAuthenticationExtensionId")

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

Example Usage: CustomAuthenticationExtensionClient.GetCustomAuthenticationExtensionsCount

ctx := context.TODO()


read, err := client.GetCustomAuthenticationExtensionsCount(ctx, customauthenticationextension.DefaultGetCustomAuthenticationExtensionsCountOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CustomAuthenticationExtensionClient.ListCustomAuthenticationExtensions

ctx := context.TODO()


// alternatively `client.ListCustomAuthenticationExtensions(ctx, customauthenticationextension.DefaultListCustomAuthenticationExtensionsOperationOptions())` can be used to do batched pagination
items, err := client.ListCustomAuthenticationExtensionsComplete(ctx, customauthenticationextension.DefaultListCustomAuthenticationExtensionsOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: CustomAuthenticationExtensionClient.UpdateCustomAuthenticationExtension

ctx := context.TODO()
id := customauthenticationextension.NewIdentityCustomAuthenticationExtensionID("customAuthenticationExtensionId")

payload := customauthenticationextension.CustomAuthenticationExtension{
	// ...
}


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

Example Usage: CustomAuthenticationExtensionClient.ValidateCustomAuthenticationExtensionAuthenticationConfiguration

ctx := context.TODO()
id := customauthenticationextension.NewIdentityCustomAuthenticationExtensionID("customAuthenticationExtensionId")

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

Example Usage: CustomAuthenticationExtensionClient.ValidateCustomAuthenticationExtensionsAuthenticationConfiguration

ctx := context.TODO()

payload := customauthenticationextension.ValidateCustomAuthenticationExtensionsAuthenticationConfigurationRequest{
	// ...
}


read, err := client.ValidateCustomAuthenticationExtensionsAuthenticationConfiguration(ctx, payload, customauthenticationextension.DefaultValidateCustomAuthenticationExtensionsAuthenticationConfigurationOperationOptions())
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 CreateCustomAuthenticationExtensionOperationOptions

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

func DefaultCreateCustomAuthenticationExtensionOperationOptions

func DefaultCreateCustomAuthenticationExtensionOperationOptions() CreateCustomAuthenticationExtensionOperationOptions

func (CreateCustomAuthenticationExtensionOperationOptions) ToHeaders

func (CreateCustomAuthenticationExtensionOperationOptions) ToOData

func (CreateCustomAuthenticationExtensionOperationOptions) ToQuery

type CreateCustomAuthenticationExtensionOperationResponse

type CreateCustomAuthenticationExtensionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.CustomAuthenticationExtension
}

type CustomAuthenticationExtensionClient

type CustomAuthenticationExtensionClient struct {
	Client *msgraph.Client
}

func NewCustomAuthenticationExtensionClientWithBaseURI

func NewCustomAuthenticationExtensionClientWithBaseURI(sdkApi sdkEnv.Api) (*CustomAuthenticationExtensionClient, error)

func (CustomAuthenticationExtensionClient) CreateCustomAuthenticationExtension

CreateCustomAuthenticationExtension - Create customAuthenticationExtension. Create a new customAuthenticationExtension object. The following derived types are currently supported.

func (CustomAuthenticationExtensionClient) DeleteCustomAuthenticationExtension

DeleteCustomAuthenticationExtension - Delete customAuthenticationExtension. Delete a customAuthenticationExtension object.

func (CustomAuthenticationExtensionClient) GetCustomAuthenticationExtension

GetCustomAuthenticationExtension - Get customAuthenticationExtension. Read the properties and relationships of a customAuthenticationExtension object.

func (CustomAuthenticationExtensionClient) GetCustomAuthenticationExtensionsCount

GetCustomAuthenticationExtensionsCount - Get the number of the resource

func (CustomAuthenticationExtensionClient) ListCustomAuthenticationExtensions

ListCustomAuthenticationExtensions - List customAuthenticationExtensions. Get a list of the customAuthenticationExtension objects and their properties. The following derived types are supported.

func (CustomAuthenticationExtensionClient) ListCustomAuthenticationExtensionsComplete

ListCustomAuthenticationExtensionsComplete retrieves all the results into a single object

func (CustomAuthenticationExtensionClient) ListCustomAuthenticationExtensionsCompleteMatchingPredicate

ListCustomAuthenticationExtensionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CustomAuthenticationExtensionClient) UpdateCustomAuthenticationExtension

UpdateCustomAuthenticationExtension - Update customAuthenticationExtension. Update the properties of a customAuthenticationExtension object.

func (CustomAuthenticationExtensionClient) ValidateCustomAuthenticationExtensionAuthenticationConfiguration

ValidateCustomAuthenticationExtensionAuthenticationConfiguration - Invoke action validateAuthenticationConfiguration. An API to check validity of the endpoint and and authentication configuration for a customAuthenticationExtension.

func (CustomAuthenticationExtensionClient) ValidateCustomAuthenticationExtensionsAuthenticationConfiguration

ValidateCustomAuthenticationExtensionsAuthenticationConfiguration - Invoke action validateAuthenticationConfiguration

type CustomAuthenticationExtensionOperationPredicate

type CustomAuthenticationExtensionOperationPredicate struct {
}

func (CustomAuthenticationExtensionOperationPredicate) Matches

type DeleteCustomAuthenticationExtensionOperationOptions

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

func DefaultDeleteCustomAuthenticationExtensionOperationOptions

func DefaultDeleteCustomAuthenticationExtensionOperationOptions() DeleteCustomAuthenticationExtensionOperationOptions

func (DeleteCustomAuthenticationExtensionOperationOptions) ToHeaders

func (DeleteCustomAuthenticationExtensionOperationOptions) ToOData

func (DeleteCustomAuthenticationExtensionOperationOptions) ToQuery

type DeleteCustomAuthenticationExtensionOperationResponse

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

type GetCustomAuthenticationExtensionOperationOptions

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

func DefaultGetCustomAuthenticationExtensionOperationOptions

func DefaultGetCustomAuthenticationExtensionOperationOptions() GetCustomAuthenticationExtensionOperationOptions

func (GetCustomAuthenticationExtensionOperationOptions) ToHeaders

func (GetCustomAuthenticationExtensionOperationOptions) ToOData

func (GetCustomAuthenticationExtensionOperationOptions) ToQuery

type GetCustomAuthenticationExtensionOperationResponse

type GetCustomAuthenticationExtensionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.CustomAuthenticationExtension
}

type GetCustomAuthenticationExtensionsCountOperationOptions

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

func DefaultGetCustomAuthenticationExtensionsCountOperationOptions

func DefaultGetCustomAuthenticationExtensionsCountOperationOptions() GetCustomAuthenticationExtensionsCountOperationOptions

func (GetCustomAuthenticationExtensionsCountOperationOptions) ToHeaders

func (GetCustomAuthenticationExtensionsCountOperationOptions) ToOData

func (GetCustomAuthenticationExtensionsCountOperationOptions) ToQuery

type GetCustomAuthenticationExtensionsCountOperationResponse

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

type ListCustomAuthenticationExtensionsCompleteResult

type ListCustomAuthenticationExtensionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.CustomAuthenticationExtension
}

type ListCustomAuthenticationExtensionsCustomPager

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

type ListCustomAuthenticationExtensionsOperationOptions

type ListCustomAuthenticationExtensionsOperationOptions 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 DefaultListCustomAuthenticationExtensionsOperationOptions

func DefaultListCustomAuthenticationExtensionsOperationOptions() ListCustomAuthenticationExtensionsOperationOptions

func (ListCustomAuthenticationExtensionsOperationOptions) ToHeaders

func (ListCustomAuthenticationExtensionsOperationOptions) ToOData

func (ListCustomAuthenticationExtensionsOperationOptions) ToQuery

type ListCustomAuthenticationExtensionsOperationResponse

type ListCustomAuthenticationExtensionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.CustomAuthenticationExtension
}

type UpdateCustomAuthenticationExtensionOperationOptions

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

func DefaultUpdateCustomAuthenticationExtensionOperationOptions

func DefaultUpdateCustomAuthenticationExtensionOperationOptions() UpdateCustomAuthenticationExtensionOperationOptions

func (UpdateCustomAuthenticationExtensionOperationOptions) ToHeaders

func (UpdateCustomAuthenticationExtensionOperationOptions) ToOData

func (UpdateCustomAuthenticationExtensionOperationOptions) ToQuery

type UpdateCustomAuthenticationExtensionOperationResponse

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

type ValidateCustomAuthenticationExtensionAuthenticationConfigurationOperationOptions

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

func (ValidateCustomAuthenticationExtensionAuthenticationConfigurationOperationOptions) ToHeaders

func (ValidateCustomAuthenticationExtensionAuthenticationConfigurationOperationOptions) ToOData

func (ValidateCustomAuthenticationExtensionAuthenticationConfigurationOperationOptions) ToQuery

type ValidateCustomAuthenticationExtensionAuthenticationConfigurationOperationResponse

type ValidateCustomAuthenticationExtensionAuthenticationConfigurationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.AuthenticationConfigurationValidation
}

type ValidateCustomAuthenticationExtensionsAuthenticationConfigurationOperationOptions

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

func (ValidateCustomAuthenticationExtensionsAuthenticationConfigurationOperationOptions) ToHeaders

func (ValidateCustomAuthenticationExtensionsAuthenticationConfigurationOperationOptions) ToOData

func (ValidateCustomAuthenticationExtensionsAuthenticationConfigurationOperationOptions) ToQuery

type ValidateCustomAuthenticationExtensionsAuthenticationConfigurationOperationResponse

type ValidateCustomAuthenticationExtensionsAuthenticationConfigurationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.AuthenticationConfigurationValidation
}

type ValidateCustomAuthenticationExtensionsAuthenticationConfigurationRequest

type ValidateCustomAuthenticationExtensionsAuthenticationConfigurationRequest struct {
	AuthenticationConfiguration *stable.CustomExtensionAuthenticationConfiguration `json:"authenticationConfiguration,omitempty"`
	EndpointConfiguration       *stable.CustomExtensionEndpointConfiguration       `json:"endpointConfiguration,omitempty"`
}

Jump to

Keyboard shortcuts

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