Aspire.Hosting.Azure.EntraId
Official
📦 Aspire.Hosting.Azure.EntraIdv17.0.0-preview.1.26565.2Import path
apphost/modules/aspire35Functions
10Types
10 types, 35 functions and 0 members
Handles
DTOs
Enums
Functions
DistributedApplicationBuilder
method
AddEntraIdApplicationbuilderAdds a Microsoft Entra ID application registration resource to the application model.
AddEntraIdApplication(name string) EntraIdApplicationResourcemethod
AddExistingEntraIdApplicationbuilderReferences an existing registration without enabling Azure provisioning or querying Microsoft Graph.
AddExistingEntraIdApplication(name string, tenantId any, clientId any) EntraIdApplicationResourceEntraIdApplicationResource
method
AsExistingApplicationbuilderReferences an existing registration without undoing the Azure provisioning setup enabled when this resource was added.
AsExistingApplication(tenantId any, clientId any) EntraIdApplicationResourcemethod
GetScopeUriGets an expression for the full URI of one of this registration's scopes, such as api://{clientId}/access_as_user.
GetScopeUri(scopeName string) *ReferenceExpressionmethod
PublishWithAppRoleAssignmentbuilderPublishes explicit application-role assignments to a managed identity or a compute resource's managed identity.
PublishWithAppRoleAssignment(identity any, roleValues []string) EntraIdApplicationResourcemethod
PublishWithFederatedManagedIdentityCredentialbuilderPublishes managed identity federation trust for a registration created by Aspire.
PublishWithFederatedManagedIdentityCredential(options ...*PublishWithFederatedManagedIdentityCredentialOptions) EntraIdApplicationResourcemethod
RunWithLocalDeveloperCertificateCredentialbuilderCreates and provisions a short-lived certificate credential for local development.
RunWithLocalDeveloperCertificateCredential() EntraIdApplicationResourcemethod
WithAdminConsentbuilderGrants tenant-wide consent to delegated permissions that this registration declared for another registration in the AppHost.
WithAdminConsent(api EntraIdApplicationResource, scopeNames []string) EntraIdApplicationResourcemethod
WithAllowWebApiToBeAuthorizedByACLbuilderEnables ACL-based authorization for daemon-to-API scenarios.
WithAllowWebApiToBeAuthorizedByACL() EntraIdApplicationResourcemethod
WithApiPermissionsbuilderDeclares that this registration requires delegated permissions to scopes of another registration in the AppHost.
WithApiPermissions(api EntraIdApplicationResource, scopeNames []string) EntraIdApplicationResourcemethod
WithApplicationIdUribuilderExposes the registration as an API identified by an application ID URI.
WithApplicationIdUri(options ...*WithApplicationIdUriOptions) EntraIdApplicationResourcemethod
WithApplicationOwnersbuilderAppends an application owner supplied as a literal directory object GUID or a parameter.
WithApplicationOwners(ownerObjectId any) EntraIdApplicationResourcemethod
WithAppRolebuilderDeclares an application role on a registration created by Aspire.
WithAppRole(value string, displayName string, description string, options ...*WithAppRoleOptions) EntraIdApplicationResourcemethod
WithAudiencebuilderAdds an accepted audience for this application.
WithAudience(audience string) EntraIdApplicationResourcemethod
WithCertificateDistinguishedNamebuilderAdds a certificate credential from the certificate store by distinguished name.
WithCertificateDistinguishedName(storePath string, distinguishedName string) EntraIdApplicationResourcemethod
WithCertificateFromFilebuilderAppends a certificate file credential. The file path is on the consuming resource, not the AppHost.
WithCertificateFromFile(filePath string, options ...*WithCertificateFromFileOptions) EntraIdApplicationResourcemethod
WithCertificateFromKeyVaultbuilderAdds a certificate credential using a vault URL or Key Vault resource.
WithCertificateFromKeyVault(keyVaultUrl any, certificateName string) EntraIdApplicationResourcemethod
WithCertificateThumbprintbuilderAdds a certificate credential from the certificate store by thumbprint.
WithCertificateThumbprint(storePath string, thumbprint string) EntraIdApplicationResourcemethod
WithClientCapabilitybuilderAdds a client capability (e.g.,
"cp1" for Continuous Access Evaluation).WithClientCapability(capability string) EntraIdApplicationResourcemethod
WithClientSecretbuilderAdds a client secret credential to this Entra ID application.
WithClientSecret(clientSecret ParameterResource) EntraIdApplicationResourcemethod
WithExternalApiAdminConsentbuilderGrants tenant-wide consent to permissions that this registration declared for an API that is not an Aspire resource.
WithExternalApiAdminConsent(api any, permissions []*EntraIdExternalApiPermission) EntraIdApplicationResourcemethod
WithExternalApiPermissionsbuilderDeclares permissions to a Microsoft first-party or other API that is not an Aspire resource, such as Microsoft Graph.
WithExternalApiPermissions(api any, permissions []*EntraIdExternalApiPermission) EntraIdApplicationResourcemethod
WithExtraQueryParameterbuilderAdds an extra query parameter to send to the identity provider.
WithExtraQueryParameter(key string, value string) EntraIdApplicationResourcemethod
WithFederatedManagedIdentityCredentialbuilderConfigures a pre-existing managed identity trust for token acquisition, without provisioning or assigning an identity.
WithFederatedManagedIdentityCredential(managedIdentityClientId string, options ...*EntraIdTokenExchangeOptions) EntraIdApplicationResourcemethod
WithIdTokenIssuancebuilderEnables ID-token issuance through implicit and hybrid flows for a registration created by Aspire.
WithIdTokenIssuance() EntraIdApplicationResourcemethod
WithInstancebuilderConfigures the Entra ID instance URL. Defaults to
https://login.microsoftonline.com/ .WithInstance(instance string) EntraIdApplicationResourcemethod
WithOwnersbuilderAppends an owner to both the application registration and service principal.
WithOwners(ownerObjectId any) EntraIdApplicationResourcemethod
WithPreAuthorizedApplicationbuilderPre-authorizes a client application to request some of this registration's scopes without any consent prompt.
WithPreAuthorizedApplication(client EntraIdApplicationResource, scopeNames []string) EntraIdApplicationResourcemethod
WithRedirectUrisbuilderAppends web redirect URIs supplied as a literal, a parameter, or an endpoint.
WithRedirectUris(redirectUri any, options ...*WithRedirectUrisOptions) EntraIdApplicationResourcemethod
WithScopebuilderExposes a delegated permission scope that clients can request to call this registration as an API.
WithScope(name string, description string, options ...*EntraIdScopeOptions) EntraIdApplicationResourcemethod
WithSendX5CbuilderSends the
x5c claim (the public key of the certificate) with token requests.WithSendX5C() EntraIdApplicationResourcemethod
WithServicePrincipalOwnersbuilderAppends a service principal owner supplied as a literal directory object GUID or a parameter.
WithServicePrincipalOwners(ownerObjectId any) EntraIdApplicationResourcemethod
WithSignedAssertionFilebuilderAppends a signed assertion file credential, such as an AKS workload identity token.
WithSignedAssertionFile(options ...*WithSignedAssertionFileOptions) EntraIdApplicationResourcemethod
WithSignInAudiencebuilderConfigures which accounts can sign in to this application.
WithSignInAudience(signInAudience EntraIdSignInAudience) EntraIdApplicationResource