microsoft_kiota_authentication_azure

README

Kiota Azure Identity authentication provider library for go

The Kiota Azure Identity authentication provider library for go is the authentication provider implementation with Azure.Identity.

A Kiota generated project will need a reference to a authentication provider library to authenticate HTTP requests to an API endpoint.

Read more about Kiota here.

Using Azure Identity authentication provider library for go

go get github.com/microsoft/kiota-authentication-azure-go

cred, err := azidentity.NewDeviceCodeCredential(nil)
authProvider, err := kiotaazure.NewAzureIdentityAuthenticationProviderWithScopes(cred, []string{"User.Read"})

// azidentity is an import of github.com/Azure/azure-sdk-for-go/sdk/azidentity
// kiotaazure is an import of github.com/microsoft/kiota-authentication-azure-go

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Documentation

Overview

Package microsoft_kiota_authentication_azure implements Kiota abstractions for authentication using the Azure Core library. In order to use this package, you must also add the github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Index

• Variables
• type AzureIdentityAccessTokenProvider
  • func NewAzureIdentityAccessTokenProvider(credential azcore.TokenCredential) (*AzureIdentityAccessTokenProvider, error)
  • func NewAzureIdentityAccessTokenProviderWithScopes(credential azcore.TokenCredential, scopes []string) (*AzureIdentityAccessTokenProvider, error)
  • func NewAzureIdentityAccessTokenProviderWithScopesAndValidHosts(credential azcore.TokenCredential, scopes []string, validHosts []string) (*AzureIdentityAccessTokenProvider, error)
  • func NewAzureIdentityAccessTokenProviderWithScopesAndValidHostsAndObservabilityOptions(credential azcore.TokenCredential, scopes []string, validHosts []string, ...) (*AzureIdentityAccessTokenProvider, error)
  • func (p *AzureIdentityAccessTokenProvider) GetAllowedHostsValidator() *absauth.AllowedHostsValidator
  • func (p *AzureIdentityAccessTokenProvider) GetAuthorizationToken(ctx context.Context, url *u.URL, ...) (string, error)
• type AzureIdentityAuthenticationProvider
  • func NewAzureIdentityAuthenticationProvider(credential azcore.TokenCredential) (*AzureIdentityAuthenticationProvider, error)
  • func NewAzureIdentityAuthenticationProviderWithScopes(credential azcore.TokenCredential, scopes []string) (*AzureIdentityAuthenticationProvider, error)
  • func NewAzureIdentityAuthenticationProviderWithScopesAndValidHosts(credential azcore.TokenCredential, scopes []string, validHosts []string) (*AzureIdentityAuthenticationProvider, error)
  • func NewAzureIdentityAuthenticationProviderWithScopesAndValidHostsAndObservabilityOptions(credential azcore.TokenCredential, scopes []string, validHosts []string, ...) (*AzureIdentityAuthenticationProvider, error)
• type ObservabilityOptions
  • func (o ObservabilityOptions) GetTracerInstrumentationName() string

Variables

var LocalhostStrings = [4]string{"localhost", "[::1]", "::1", "127.0.0.1"}

Types

type AzureIdentityAccessTokenProvider

type AzureIdentityAccessTokenProvider struct {
	// contains filtered or unexported fields
}

AzureIdentityAccessTokenProvider implementation of AccessTokenProvider that supports implementations of TokenCredential from Azure.Identity.

func NewAzureIdentityAccessTokenProvider

func NewAzureIdentityAccessTokenProvider(credential azcore.TokenCredential) (*AzureIdentityAccessTokenProvider, error)

NewAzureIdentityAccessTokenProvider creates a new instance of the AzureIdentityAccessTokenProvider using "<scheme>://<host>/.default" as the default scope.

func NewAzureIdentityAccessTokenProviderWithScopes

func NewAzureIdentityAccessTokenProviderWithScopes(credential azcore.TokenCredential, scopes []string) (*AzureIdentityAccessTokenProvider, error)

NewAzureIdentityAccessTokenProviderWithScopes creates a new instance of the AzureIdentityAccessTokenProvider.

func NewAzureIdentityAccessTokenProviderWithScopesAndValidHosts

func NewAzureIdentityAccessTokenProviderWithScopesAndValidHosts(credential azcore.TokenCredential, scopes []string, validHosts []string) (*AzureIdentityAccessTokenProvider, error)

NewAzureIdentityAccessTokenProviderWithScopesAndValidHosts creates a new instance of the AzureIdentityAccessTokenProvider.

func NewAzureIdentityAccessTokenProviderWithScopesAndValidHostsAndObservabilityOptions

func NewAzureIdentityAccessTokenProviderWithScopesAndValidHostsAndObservabilityOptions(credential azcore.TokenCredential, scopes []string, validHosts []string, observabilityOptions ObservabilityOptions) (*AzureIdentityAccessTokenProvider, error)

NewAzureIdentityAccessTokenProviderWithScopesAndValidHosts creates a new instance of the AzureIdentityAccessTokenProvider.

func (*AzureIdentityAccessTokenProvider) GetAllowedHostsValidator

func (p *AzureIdentityAccessTokenProvider) GetAllowedHostsValidator() *absauth.AllowedHostsValidator

GetAllowedHostsValidator returns the hosts validator.

func (*AzureIdentityAccessTokenProvider) GetAuthorizationToken

func (p *AzureIdentityAccessTokenProvider) GetAuthorizationToken(ctx context.Context, url *u.URL, additionalAuthenticationContext map[string]interface{}) (string, error)

GetAuthorizationToken returns the access token for the provided url.

type AzureIdentityAuthenticationProvider

type AzureIdentityAuthenticationProvider struct {
	auth.BaseBearerTokenAuthenticationProvider
}

AzureIdentityAuthenticationProvider implementation of AuthenticationProvider that supports implementations of TokenCredential from Azure.Identity.

func NewAzureIdentityAuthenticationProvider

func NewAzureIdentityAuthenticationProvider(credential azcore.TokenCredential) (*AzureIdentityAuthenticationProvider, error)

NewAzureIdentityAuthenticationProvider creates a new instance of the AzureIdentityAuthenticationProvider using "https://graph.microsoft.com/.default" as the default scope.

func NewAzureIdentityAuthenticationProviderWithScopes

func NewAzureIdentityAuthenticationProviderWithScopes(credential azcore.TokenCredential, scopes []string) (*AzureIdentityAuthenticationProvider, error)

NewAzureIdentityAuthenticationProviderWithScopes creates a new instance of the AzureIdentityAuthenticationProvider.

func NewAzureIdentityAuthenticationProviderWithScopesAndValidHosts

func NewAzureIdentityAuthenticationProviderWithScopesAndValidHosts(credential azcore.TokenCredential, scopes []string, validHosts []string) (*AzureIdentityAuthenticationProvider, error)

NewAzureIdentityAuthenticationProviderWithScopesAndValidHosts creates a new instance of the AzureIdentityAuthenticationProvider.

func NewAzureIdentityAuthenticationProviderWithScopesAndValidHostsAndObservabilityOptions

func NewAzureIdentityAuthenticationProviderWithScopesAndValidHostsAndObservabilityOptions(credential azcore.TokenCredential, scopes []string, validHosts []string, observabilityOptions ObservabilityOptions) (*AzureIdentityAuthenticationProvider, error)

NewAzureIdentityAuthenticationProviderWithScopesAndValidHostsAndObservabilityOptions creates a new instance of the AzureIdentityAuthenticationProvider.

type ObservabilityOptions

type ObservabilityOptions struct {
}

ObservabilityOptions holds the tracing, metrics and logging configuration for the request adapter

func (ObservabilityOptions) GetTracerInstrumentationName

func (o ObservabilityOptions) GetTracerInstrumentationName() string