Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

Aspire.Hosting.Azure.EntraId

Official
📦 Aspire.Hosting.Azure.EntraIdv17.0.0-preview.1.26565.2
Import pathapphost/modules/aspire
35Functions
10Types

Handles

DTOs

Enums

Functions

EntraIdApplicationResource

methodAsExistingApplicationbuilder
References an existing registration without undoing the Azure provisioning setup enabled when this resource was added.
AsExistingApplication(tenantId any, clientId any) EntraIdApplicationResource
methodGetScopeUri
Gets an expression for the full URI of one of this registration's scopes, such as api://{clientId}/access_as_user.
GetScopeUri(scopeName string) *ReferenceExpression
methodPublishWithAppRoleAssignmentbuilder
Publishes explicit application-role assignments to a managed identity or a compute resource's managed identity.
PublishWithAppRoleAssignment(identity any, roleValues []string) EntraIdApplicationResource
methodPublishWithFederatedManagedIdentityCredentialbuilder
Publishes managed identity federation trust for a registration created by Aspire.
PublishWithFederatedManagedIdentityCredential(options ...*PublishWithFederatedManagedIdentityCredentialOptions) EntraIdApplicationResource
methodRunWithLocalDeveloperCertificateCredentialbuilder
Creates and provisions a short-lived certificate credential for local development.
RunWithLocalDeveloperCertificateCredential() EntraIdApplicationResource
methodWithAdminConsentbuilder
Grants tenant-wide consent to delegated permissions that this registration declared for another registration in the AppHost.
WithAdminConsent(api EntraIdApplicationResource, scopeNames []string) EntraIdApplicationResource
methodWithAllowWebApiToBeAuthorizedByACLbuilder
Enables ACL-based authorization for daemon-to-API scenarios.
WithAllowWebApiToBeAuthorizedByACL() EntraIdApplicationResource
methodWithApiPermissionsbuilder
Declares that this registration requires delegated permissions to scopes of another registration in the AppHost.
WithApiPermissions(api EntraIdApplicationResource, scopeNames []string) EntraIdApplicationResource
methodWithApplicationIdUribuilder
Exposes the registration as an API identified by an application ID URI.
WithApplicationIdUri(options ...*WithApplicationIdUriOptions) EntraIdApplicationResource
methodWithApplicationOwnersbuilder
Appends an application owner supplied as a literal directory object GUID or a parameter.
WithApplicationOwners(ownerObjectId any) EntraIdApplicationResource
methodWithAppRolebuilder
Declares an application role on a registration created by Aspire.
WithAppRole(value string, displayName string, description string, options ...*WithAppRoleOptions) EntraIdApplicationResource
methodWithAudiencebuilder
Adds an accepted audience for this application.
WithAudience(audience string) EntraIdApplicationResource
methodWithCertificateDistinguishedNamebuilder
Adds a certificate credential from the certificate store by distinguished name.
WithCertificateDistinguishedName(storePath string, distinguishedName string) EntraIdApplicationResource
methodWithCertificateFromFilebuilder
Appends a certificate file credential. The file path is on the consuming resource, not the AppHost.
WithCertificateFromFile(filePath string, options ...*WithCertificateFromFileOptions) EntraIdApplicationResource
methodWithCertificateFromKeyVaultbuilder
Adds a certificate credential using a vault URL or Key Vault resource.
WithCertificateFromKeyVault(keyVaultUrl any, certificateName string) EntraIdApplicationResource
methodWithCertificateThumbprintbuilder
Adds a certificate credential from the certificate store by thumbprint.
WithCertificateThumbprint(storePath string, thumbprint string) EntraIdApplicationResource
methodWithClientCapabilitybuilder
Adds a client capability (e.g., "cp1" for Continuous Access Evaluation).
WithClientCapability(capability string) EntraIdApplicationResource
methodWithClientSecretbuilder
Adds a client secret credential to this Entra ID application.
WithClientSecret(clientSecret ParameterResource) EntraIdApplicationResource
methodWithExternalApiAdminConsentbuilder
Grants tenant-wide consent to permissions that this registration declared for an API that is not an Aspire resource.
WithExternalApiAdminConsent(api any, permissions []*EntraIdExternalApiPermission) EntraIdApplicationResource
methodWithExternalApiPermissionsbuilder
Declares permissions to a Microsoft first-party or other API that is not an Aspire resource, such as Microsoft Graph.
WithExternalApiPermissions(api any, permissions []*EntraIdExternalApiPermission) EntraIdApplicationResource
methodWithExtraQueryParameterbuilder
Adds an extra query parameter to send to the identity provider.
WithExtraQueryParameter(key string, value string) EntraIdApplicationResource
methodWithFederatedManagedIdentityCredentialbuilder
Configures a pre-existing managed identity trust for token acquisition, without provisioning or assigning an identity.
WithFederatedManagedIdentityCredential(managedIdentityClientId string, options ...*EntraIdTokenExchangeOptions) EntraIdApplicationResource
methodWithIdTokenIssuancebuilder
Enables ID-token issuance through implicit and hybrid flows for a registration created by Aspire.
WithIdTokenIssuance() EntraIdApplicationResource
methodWithInstancebuilder
Configures the Entra ID instance URL. Defaults to https://login.microsoftonline.com/.
WithInstance(instance string) EntraIdApplicationResource
methodWithOwnersbuilder
Appends an owner to both the application registration and service principal.
WithOwners(ownerObjectId any) EntraIdApplicationResource
methodWithPreAuthorizedApplicationbuilder
Pre-authorizes a client application to request some of this registration's scopes without any consent prompt.
WithPreAuthorizedApplication(client EntraIdApplicationResource, scopeNames []string) EntraIdApplicationResource
methodWithRedirectUrisbuilder
Appends web redirect URIs supplied as a literal, a parameter, or an endpoint.
WithRedirectUris(redirectUri any, options ...*WithRedirectUrisOptions) EntraIdApplicationResource
methodWithScopebuilder
Exposes a delegated permission scope that clients can request to call this registration as an API.
WithScope(name string, description string, options ...*EntraIdScopeOptions) EntraIdApplicationResource
methodWithSendX5Cbuilder
Sends the x5c claim (the public key of the certificate) with token requests.
WithSendX5C() EntraIdApplicationResource
methodWithServicePrincipalOwnersbuilder
Appends a service principal owner supplied as a literal directory object GUID or a parameter.
WithServicePrincipalOwners(ownerObjectId any) EntraIdApplicationResource
methodWithSignedAssertionFilebuilder
Appends a signed assertion file credential, such as an AKS workload identity token.
WithSignedAssertionFile(options ...*WithSignedAssertionFileOptions) EntraIdApplicationResource
methodWithSignInAudiencebuilder
Configures which accounts can sign in to this application.
WithSignInAudience(signInAudience EntraIdSignInAudience) EntraIdApplicationResource