Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

EntraIdScopeOptions

Struct
📦 Aspire.Hosting.Azure.EntraId v17.0.0-preview.1.26565.2

Optional settings for a scope exposed by a created registration or described by an existing reference.

type EntraIdScopeOptions struct {
DisplayName *string `json:"DisplayName"`
UserConsentDisplayName *string `json:"UserConsentDisplayName"`
UserConsentDescription *string `json:"UserConsentDescription"`
RequiresAdminConsent *bool `json:"RequiresAdminConsent"`
IsEnabled *bool `json:"IsEnabled"`
Id *string `json:"Id"`
}

Fields

DisplayName*stringoptional
Gets the scope's title, shown on the admin consent page. Defaults to the scope's name.
UserConsentDisplayName*stringoptional
Gets the scope's title shown on the consent page for users. Defaults to the display name.
UserConsentDescription*stringoptional
Gets what the scope allows, shown on the consent page for users. Defaults to the scope's description.
RequiresAdminConsent*booloptional
Gets whether only an administrator can consent to the scope. Defaults to false, which lets users consent.
IsEnabled*booloptional
Gets whether clients can request the scope. Defaults to true.
Id*stringoptional
Gets the scope's ID as a GUID, which must stay the same across deployments. Aspire derives a stable ID when omitted.