environments

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 5 Imported by: 11,638

Documentation

Index

Constants

View Source 
const AzureChinaCloud = "China"
View Source 
const AzurePublicCloud = "Public"
View Source 
const AzureUSGovernmentCloud = "USGovernment"

Variables

View Source 
var PublishedApis = map[string]string{}/* 120 elements not displayed */

PublishedApis is a map containing Application IDs for well known APIs published by Microsoft. They can be used to acquire access tokens, but are primarily described here for easy inclusion in application manifests and service principal assignments.

Functions

func ApiIsKnownPublished added in v0.20240610.1112704 

func ApiIsKnownPublished(api Api, apiName string) bool

ApiIsKnownPublished determines whether the provided Api represents the specified known API as published in PublishedApis

func Resource 

func Resource(endpoint Api) (*string, error)

func Scope 

func Scope(endpoint Api) (*string, error)

Types

type Api 

type Api interface {
	// AppId is a GUID that identifies the application/API in the cloud environment
	AppId() (*string, bool)

	// Available returns whether the application/API is supported in the cloud environment
	Available() bool

	// DomainSuffix is the specific domain suffix for constructing endpoints for a data plane API in the cloud environment
	DomainSuffix() (*string, bool)

	// Endpoint is the common endpoint for the application/API in the cloud environment
	Endpoint() (*string, bool)

	// Name returns the name of the application/API
	Name() string

	// ResourceIdentifier is a URI that identifies the application/API in the cloud environment and
	// is used for constructing scopes/roles when authorizing connections.
	ResourceIdentifier() (*string, bool)

	// WithResourceIdentifier overrides the default resource ID for the API and is useful for APIs that offer multiple authorization scopes
	WithResourceIdentifier(string) Api
}

func ServiceBusAPI 

func ServiceBusAPI(endpoint, domainSuffix string) Api

func StorageSyncAPI 

func StorageSyncAPI(domainSuffix string) Api

func TrafficManagerAPI 

func TrafficManagerAPI(domainSuffix string) Api

type ApiEndpoint 

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

func ApiManagementAPI 

func ApiManagementAPI(domainSuffix string) *ApiEndpoint

func AppConfigurationAPI 

func AppConfigurationAPI(domainSuffix string) *ApiEndpoint

func AttestationAPI 

func AttestationAPI(endpoint, domainSuffix string) *ApiEndpoint

func BatchAPI 

func BatchAPI(resourceId string) *ApiEndpoint

func CDNFrontDoorAPI 

func CDNFrontDoorAPI(domainSuffix string) *ApiEndpoint

func ContainerRegistryAPI 

func ContainerRegistryAPI(domainSuffix string) *ApiEndpoint

func CosmosDBAPI 

func CosmosDBAPI(domainSuffix string) *ApiEndpoint

func DataLakeAPI 

func DataLakeAPI(domainSuffix string) *ApiEndpoint

func IoTCentral 

func IoTCentral(domainSuffix string) *ApiEndpoint

func KeyVaultAPI 

func KeyVaultAPI(domainSuffix string) *ApiEndpoint

func ManagedHSMAPI 

func ManagedHSMAPI(endpoint, domainSuffix string) *ApiEndpoint

func MariaDBAPI 

func MariaDBAPI(domainSuffix string) *ApiEndpoint

func MicrosoftGraphAPI 

func MicrosoftGraphAPI(resourceId string) *ApiEndpoint

func MySqlAPI 

func MySqlAPI(domainSuffix string) *ApiEndpoint

func NewApiEndpoint 

func NewApiEndpoint(name, endpoint string, appId *string) *ApiEndpoint

func OperationalInsightsAPI 

func OperationalInsightsAPI() *ApiEndpoint

func PostgresqlAPI 

func PostgresqlAPI(domainSuffix string) *ApiEndpoint

func ResourceManagerAPI 

func ResourceManagerAPI(endpoint string) *ApiEndpoint

func SqlAPI 

func SqlAPI(domainSuffix string) *ApiEndpoint

func StorageAPI 

func StorageAPI(domainSuffix string) *ApiEndpoint

func SynapseAPI 

func SynapseAPI(domainSuffix string) *ApiEndpoint

func (*ApiEndpoint) AppId 

func (e *ApiEndpoint) AppId() (*string, bool)

func (*ApiEndpoint) Available 

func (e *ApiEndpoint) Available() bool

func (*ApiEndpoint) DomainSuffix 

func (e *ApiEndpoint) DomainSuffix() (*string, bool)

func (*ApiEndpoint) Endpoint 

func (e *ApiEndpoint) Endpoint() (*string, bool)

func (*ApiEndpoint) Name 

func (e *ApiEndpoint) Name() string

func (*ApiEndpoint) ResourceIdentifier 

func (e *ApiEndpoint) ResourceIdentifier() (*string, bool)

func (*ApiEndpoint) WithResourceIdentifier added in v0.20240411.1104331 

func (e *ApiEndpoint) WithResourceIdentifier(identifier string) Api

type Authorization 

type Authorization struct {
	Audiences        []string
	IdentityProvider string
	LoginEndpoint    string
	Tenant           string
}

type Environment 

type Environment struct {
	Name string

	Authorization   *Authorization
	MicrosoftGraph  Api
	ResourceManager Api

	AnalysisServices                                  Api
	ApiManagement                                     Api
	AppConfiguration                                  Api
	AppService                                        Api
	ApplicationInsights                               Api
	Attestation                                       Api
	AzureADIdentityGovernanceInsights                 Api
	AzureADIntegratedApp                              Api
	AzureADNotification                               Api
	AzureDevOps                                       Api
	AzureServiceManagement                            Api
	AzureVPN                                          Api
	Batch                                             Api
	Bing                                              Api
	BotFrameworkDevPortal                             Api
	BranchConnectWebService                           Api
	CDNFrontDoor                                      Api
	Cognitive                                         Api
	ComputeRecommendations                            Api
	Connections                                       Api
	ContainerRegistry                                 Api
	CortanaAtWork                                     Api
	CortanaAtWorkBing                                 Api
	CortanaRuntime                                    Api
	CosmosDB                                          Api
	CustomerInsights                                  Api
	DataBricks                                        Api
	DataCatalog                                       Api
	DataLake                                          Api
	DataMigrations                                    Api
	DigitalTwins                                      Api
	DomainController                                  Api
	Dynamic365BusinessCentral                         Api
	Dynamics365DataExportService                      Api
	DynamicsCRM                                       Api
	DynamicsERP                                       Api
	EventHubs                                         Api
	Flow                                              Api
	GraphConnector                                    Api
	HDInsight                                         Api
	HealthCare                                        Api
	IamSupportability                                 Api
	ImportExport                                      Api
	InTune                                            Api
	InformationProtectionSyncService                  Api
	IoTCentral                                        Api
	IoTHubDeviceProvisioning                          Api
	KeyVault                                          Api
	KubernetesServiceAADServer                        Api
	Kusto                                             Api
	KustoMFA                                          Api
	LogAnalytics                                      Api
	ManagedHSM                                        Api
	Maps                                              Api
	MariaDB                                           Api
	MediaServices                                     Api
	Microsoft365DataAtRestEncryption                  Api
	MicrosoftAzureCli                                 Api
	MicrosoftInvoicing                                Api
	MicrosoftOffice                                   Api
	MicrosoftStorageSync                              Api
	MicrosoftTeams                                    Api
	MicrosoftTeamsWebClient                           Api
	MileIqAdminCenter                                 Api
	MileIqDashboard                                   Api
	MileIqRestService                                 Api
	MixedReality                                      Api
	MySql                                             Api
	OSSRDBMSPostgreSQLFlexibleServerAadAuthentication Api
	OSSRDMBS                                          Api
	Office365Connectors                               Api
	Office365Demeter                                  Api
	Office365DwEngineV2                               Api
	Office365ExchangeOnline                           Api
	Office365ExchangeOnlineProtection                 Api
	Office365InformationProtection                    Api
	Office365Management                               Api
	Office365Portal                                   Api
	Office365SharePointOnline                         Api
	Office365SuiteUx                                  Api
	Office365Zoom                                     Api
	OfficeHome                                        Api
	OfficeUwpPwa                                      Api
	OneNote                                           Api
	OneProfile                                        Api
	OperationalInsights                               Api
	PeopleCards                                       Api
	PolicyAdministration                              Api
	Portal                                            Api
	Postgresql                                        Api
	PowerAppsRuntime                                  Api
	PowerAppsRuntimeService                           Api
	PowerBiService                                    Api
	Purview                                           Api
	RightsManagement                                  Api
	SecurityInsights                                  Api
	ServiceBus                                        Api
	ServiceDeploy                                     Api
	ServiceTrust                                      Api
	Signup                                            Api
	SkypeForBusinessOnline                            Api
	SpeechRecognition                                 Api
	Sql                                               Api
	StackHCI                                          Api
	Storage                                           Api
	StorageSync                                       Api
	StreamAnalytics                                   Api
	Synapse                                           Api
	SynapseGateway                                    Api
	SynapseStudio                                     Api
	TargetedMessaging                                 Api
	Teams                                             Api
	ThreatProtection                                  Api
	TimeSeriesInsights                                Api
	TrafficManager                                    Api
	UniversalPrint                                    Api
	WindowsDefenderATP                                Api
	WindowsVirtualDesktop                             Api
	Yammer                                            Api
}

func AzureChina 

func AzureChina() *Environment

func AzurePublic 

func AzurePublic() *Environment

func AzurePublicCanary 

func AzurePublicCanary() *Environment

func AzureUSGovernment 

func AzureUSGovernment() *Environment

func AzureUSGovernmentL5 

func AzureUSGovernmentL5() *Environment

func FromEndpoint 

func FromEndpoint(ctx context.Context, endpoint string) (*Environment, error)

FromEndpoint attempts to load an environment from the given Endpoint.

func FromName 

func FromName(name string) (*Environment, error)

func (*Environment) IsAzureStack 

func (e *Environment) IsAzureStack() bool

IsAzureStack returns whether the current Environment is an Azure Stack Environment this can be contextually useful since the Azure Stack implementation differs slightly from the other Azure Environments, particularly around Authentication.

func (*Environment) RefreshMetaDataFromEndpoint 

func (e *Environment) RefreshMetaDataFromEndpoint(ctx context.Context) error

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.