apiconnector

package
v0.20241111.1164443 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := apiconnector.NewApiConnectorClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: ApiConnectorClient.CreateApiConnector

ctx := context.TODO()

payload := apiconnector.IdentityApiConnector{
	// ...
}


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

Example Usage: ApiConnectorClient.CreateApiConnectorUploadClientCertificate

ctx := context.TODO()
id := apiconnector.NewIdentityApiConnectorID("identityApiConnectorId")

payload := apiconnector.CreateApiConnectorUploadClientCertificateRequest{
	// ...
}


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

Example Usage: ApiConnectorClient.DeleteApiConnector

ctx := context.TODO()
id := apiconnector.NewIdentityApiConnectorID("identityApiConnectorId")

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

Example Usage: ApiConnectorClient.GetApiConnector

ctx := context.TODO()
id := apiconnector.NewIdentityApiConnectorID("identityApiConnectorId")

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

Example Usage: ApiConnectorClient.GetApiConnectorsCount

ctx := context.TODO()


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

Example Usage: ApiConnectorClient.ListApiConnectors

ctx := context.TODO()


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

Example Usage: ApiConnectorClient.UpdateApiConnector

ctx := context.TODO()
id := apiconnector.NewIdentityApiConnectorID("identityApiConnectorId")

payload := apiconnector.IdentityApiConnector{
	// ...
}


read, err := client.UpdateApiConnector(ctx, id, payload, apiconnector.DefaultUpdateApiConnectorOperationOptions())
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 ApiConnectorClient 

type ApiConnectorClient struct {
	Client *msgraph.Client
}

func NewApiConnectorClientWithBaseURI 

func NewApiConnectorClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiConnectorClient, error)

func (ApiConnectorClient) CreateApiConnector 

func (c ApiConnectorClient) CreateApiConnector(ctx context.Context, input stable.IdentityApiConnector, options CreateApiConnectorOperationOptions) (result CreateApiConnectorOperationResponse, err error)

CreateApiConnector - Create identityApiConnector. Create a new identityApiConnector object.

func (ApiConnectorClient) CreateApiConnectorUploadClientCertificate 

func (c ApiConnectorClient) CreateApiConnectorUploadClientCertificate(ctx context.Context, id stable.IdentityApiConnectorId, input CreateApiConnectorUploadClientCertificateRequest, options CreateApiConnectorUploadClientCertificateOperationOptions) (result CreateApiConnectorUploadClientCertificateOperationResponse, err error)

CreateApiConnectorUploadClientCertificate - Invoke action uploadClientCertificate. Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.

func (ApiConnectorClient) DeleteApiConnector 

func (c ApiConnectorClient) DeleteApiConnector(ctx context.Context, id stable.IdentityApiConnectorId, options DeleteApiConnectorOperationOptions) (result DeleteApiConnectorOperationResponse, err error)

DeleteApiConnector - Delete identityApiConnector. Delete an identityApiConnector object.

func (ApiConnectorClient) GetApiConnector 

func (c ApiConnectorClient) GetApiConnector(ctx context.Context, id stable.IdentityApiConnectorId, options GetApiConnectorOperationOptions) (result GetApiConnectorOperationResponse, err error)

GetApiConnector - Get identityApiConnector. Read the properties of an identityApiConnector object.

func (ApiConnectorClient) GetApiConnectorsCount 

func (c ApiConnectorClient) GetApiConnectorsCount(ctx context.Context, options GetApiConnectorsCountOperationOptions) (result GetApiConnectorsCountOperationResponse, err error)

GetApiConnectorsCount - Get the number of the resource

func (ApiConnectorClient) ListApiConnectors 

func (c ApiConnectorClient) ListApiConnectors(ctx context.Context, options ListApiConnectorsOperationOptions) (result ListApiConnectorsOperationResponse, err error)

ListApiConnectors - List identityApiConnectors. Read the properties of an identityApiConnector object.

func (ApiConnectorClient) ListApiConnectorsComplete 

func (c ApiConnectorClient) ListApiConnectorsComplete(ctx context.Context, options ListApiConnectorsOperationOptions) (ListApiConnectorsCompleteResult, error)

ListApiConnectorsComplete retrieves all the results into a single object

func (ApiConnectorClient) ListApiConnectorsCompleteMatchingPredicate 

func (c ApiConnectorClient) ListApiConnectorsCompleteMatchingPredicate(ctx context.Context, options ListApiConnectorsOperationOptions, predicate IdentityApiConnectorOperationPredicate) (result ListApiConnectorsCompleteResult, err error)

ListApiConnectorsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiConnectorClient) UpdateApiConnector 

func (c ApiConnectorClient) UpdateApiConnector(ctx context.Context, id stable.IdentityApiConnectorId, input stable.IdentityApiConnector, options UpdateApiConnectorOperationOptions) (result UpdateApiConnectorOperationResponse, err error)

UpdateApiConnector - Update identityApiConnector. Update the properties of an identityApiConnector object.

type CreateApiConnectorOperationOptions 

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

func DefaultCreateApiConnectorOperationOptions 

func DefaultCreateApiConnectorOperationOptions() CreateApiConnectorOperationOptions

func (CreateApiConnectorOperationOptions) ToHeaders 

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

func (CreateApiConnectorOperationOptions) ToOData 

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

func (CreateApiConnectorOperationOptions) ToQuery 

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

type CreateApiConnectorOperationResponse 

type CreateApiConnectorOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.IdentityApiConnector
}

type CreateApiConnectorUploadClientCertificateOperationOptions 

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

func DefaultCreateApiConnectorUploadClientCertificateOperationOptions 

func DefaultCreateApiConnectorUploadClientCertificateOperationOptions() CreateApiConnectorUploadClientCertificateOperationOptions

func (CreateApiConnectorUploadClientCertificateOperationOptions) ToHeaders 

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

func (CreateApiConnectorUploadClientCertificateOperationOptions) ToOData 

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

func (CreateApiConnectorUploadClientCertificateOperationOptions) ToQuery 

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

type CreateApiConnectorUploadClientCertificateOperationResponse 

type CreateApiConnectorUploadClientCertificateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.IdentityApiConnector
}

type CreateApiConnectorUploadClientCertificateRequest 

type CreateApiConnectorUploadClientCertificateRequest struct {
	Password    nullable.Type[string] `json:"password,omitempty"`
	Pkcs12Value nullable.Type[string] `json:"pkcs12Value,omitempty"`
}

type DeleteApiConnectorOperationOptions 

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

func DefaultDeleteApiConnectorOperationOptions 

func DefaultDeleteApiConnectorOperationOptions() DeleteApiConnectorOperationOptions

func (DeleteApiConnectorOperationOptions) ToHeaders 

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

func (DeleteApiConnectorOperationOptions) ToOData 

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

func (DeleteApiConnectorOperationOptions) ToQuery 

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

type DeleteApiConnectorOperationResponse 

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

type GetApiConnectorOperationOptions 

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

func DefaultGetApiConnectorOperationOptions 

func DefaultGetApiConnectorOperationOptions() GetApiConnectorOperationOptions

func (GetApiConnectorOperationOptions) ToHeaders 

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

func (GetApiConnectorOperationOptions) ToOData 

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

func (GetApiConnectorOperationOptions) ToQuery 

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

type GetApiConnectorOperationResponse 

type GetApiConnectorOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.IdentityApiConnector
}

type GetApiConnectorsCountOperationOptions 

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

func DefaultGetApiConnectorsCountOperationOptions 

func DefaultGetApiConnectorsCountOperationOptions() GetApiConnectorsCountOperationOptions

func (GetApiConnectorsCountOperationOptions) ToHeaders 

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

func (GetApiConnectorsCountOperationOptions) ToOData 

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

func (GetApiConnectorsCountOperationOptions) ToQuery 

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

type GetApiConnectorsCountOperationResponse 

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

type IdentityApiConnectorOperationPredicate 

type IdentityApiConnectorOperationPredicate struct {
}

func (IdentityApiConnectorOperationPredicate) Matches 

func (p IdentityApiConnectorOperationPredicate) Matches(input stable.IdentityApiConnector) bool

type ListApiConnectorsCompleteResult 

type ListApiConnectorsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.IdentityApiConnector
}

type ListApiConnectorsCustomPager 

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

type ListApiConnectorsOperationOptions 

type ListApiConnectorsOperationOptions 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 DefaultListApiConnectorsOperationOptions 

func DefaultListApiConnectorsOperationOptions() ListApiConnectorsOperationOptions

func (ListApiConnectorsOperationOptions) ToHeaders 

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

func (ListApiConnectorsOperationOptions) ToOData 

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

func (ListApiConnectorsOperationOptions) ToQuery 

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

type ListApiConnectorsOperationResponse 

type ListApiConnectorsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.IdentityApiConnector
}

type UpdateApiConnectorOperationOptions 

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

func DefaultUpdateApiConnectorOperationOptions 

func DefaultUpdateApiConnectorOperationOptions() UpdateApiConnectorOperationOptions

func (UpdateApiConnectorOperationOptions) ToHeaders 

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

func (UpdateApiConnectorOperationOptions) ToOData 

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

func (UpdateApiConnectorOperationOptions) ToQuery 

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

type UpdateApiConnectorOperationResponse 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.