Files
adas-core/Documentation/docs/api/adas_core.Configurations.ServiceExtension.yml
T
2026-06-26 10:29:23 +02:00

506 lines
20 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: adas_core.Configurations.ServiceExtension
commentId: T:adas_core.Configurations.ServiceExtension
id: ServiceExtension
parent: adas_core.Configurations
children:
- adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
- adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
- adas_core.Configurations.ServiceExtension.UseProxyDevices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
langs:
- csharp
- vb
name: ServiceExtension
nameWithType: ServiceExtension
fullName: adas_core.Configurations.ServiceExtension
type: Class
source:
remote:
path: adas-core/Configurations/ServiceExtension.cs
branch: document/release/1.0.1
repo: https://git.teralevel.io/adas/adas-core.git
id: ServiceExtension
path: ../../adas-core/Configurations/ServiceExtension.cs
startLine: 15
assemblies:
- adas-core
namespace: adas_core.Configurations
summary: Provides static extension methods for service-related operations.
example: []
syntax:
content: public static class ServiceExtension
content.vb: Public Module ServiceExtension
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
commentId: M:adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
id: CreateConfigEntitiesFromAppSettingsSections(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
isExtensionMethod: true
parent: adas_core.Configurations.ServiceExtension
langs:
- csharp
- vb
name: CreateConfigEntitiesFromAppSettingsSections(WebApplicationBuilder)
nameWithType: ServiceExtension.CreateConfigEntitiesFromAppSettingsSections(WebApplicationBuilder)
fullName: adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
type: Method
source:
remote:
path: adas-core/Configurations/ServiceExtension.cs
branch: document/release/1.0.1
repo: https://git.teralevel.io/adas/adas-core.git
id: CreateConfigEntitiesFromAppSettingsSections
path: ../../adas-core/Configurations/ServiceExtension.cs
startLine: 23
assemblies:
- adas-core
namespace: adas_core.Configurations
summary: >-
Registers application configuration sections as strongly-typed options in the dependency injection container,
binding Database, RabbitMQ, Providers, Recording, Relay, Api, Auth, Redis, Cache, and List settings to the
corresponding configuration sections.
example: []
syntax:
content: public static void CreateConfigEntitiesFromAppSettingsSections(this WebApplicationBuilder builder)
parameters:
- id: builder
type: Microsoft.AspNetCore.Builder.WebApplicationBuilder
description: The <xref href="Microsoft.AspNetCore.Builder.WebApplicationBuilder" data-throw-if-not-resolved="false"></xref> whose services and configuration are used to register the option bindings.
content.vb: Public Shared Sub CreateConfigEntitiesFromAppSettingsSections(builder As WebApplicationBuilder)
overload: adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections*
- uid: adas_core.Configurations.ServiceExtension.UseProxyDevices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
commentId: M:adas_core.Configurations.ServiceExtension.UseProxyDevices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
id: UseProxyDevices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
isExtensionMethod: true
parent: adas_core.Configurations.ServiceExtension
langs:
- csharp
- vb
name: UseProxyDevices(WebApplicationBuilder)
nameWithType: ServiceExtension.UseProxyDevices(WebApplicationBuilder)
fullName: adas_core.Configurations.ServiceExtension.UseProxyDevices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
type: Method
source:
remote:
path: adas-core/Configurations/ServiceExtension.cs
branch: document/release/1.0.1
repo: https://git.teralevel.io/adas/adas-core.git
id: UseProxyDevices
path: ../../adas-core/Configurations/ServiceExtension.cs
startLine: 43
assemblies:
- adas-core
namespace: adas_core.Configurations
summary: >-
Registers the proxy device service and its configuration in the application's dependency injection container,
binding <xref href="adas_core.module.ProxyDevices.ProxyDeviceSettings" data-throw-if-not-resolved="false"></xref> from the "ProxyDevicesSettings" configuration section.
example: []
syntax:
content: public static void UseProxyDevices(this WebApplicationBuilder builder)
parameters:
- id: builder
type: Microsoft.AspNetCore.Builder.WebApplicationBuilder
description: The <xref href="Microsoft.AspNetCore.Builder.WebApplicationBuilder" data-throw-if-not-resolved="false"></xref> used to configure services and application settings.
content.vb: Public Shared Sub UseProxyDevices(builder As WebApplicationBuilder)
overload: adas_core.Configurations.ServiceExtension.UseProxyDevices*
exceptions:
- type: System.ArgumentNullException
commentId: T:System.ArgumentNullException
description: Thrown when <code class="paramref">builder</code> is <code>null</code>.
- uid: adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
commentId: M:adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
id: ConfigureJwtAuthentication(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
isExtensionMethod: true
parent: adas_core.Configurations.ServiceExtension
langs:
- csharp
- vb
name: ConfigureJwtAuthentication(WebApplicationBuilder)
nameWithType: ServiceExtension.ConfigureJwtAuthentication(WebApplicationBuilder)
fullName: adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication(Microsoft.AspNetCore.Builder.WebApplicationBuilder)
type: Method
source:
remote:
path: adas-core/Configurations/ServiceExtension.cs
branch: document/release/1.0.1
repo: https://git.teralevel.io/adas/adas-core.git
id: ConfigureJwtAuthentication
path: ../../adas-core/Configurations/ServiceExtension.cs
startLine: 58
assemblies:
- adas-core
namespace: adas_core.Configurations
summary: >-
Configures JWT Bearer authentication and authorization on the provided <xref href="Microsoft.AspNetCore.Builder.WebApplicationBuilder" data-throw-if-not-resolved="false"></xref> using settings bound from the "AuthSettings" configuration section.
If the JWT configuration is missing, the method returns without making changes; if the secret key is empty, an error is logged and an exception is thrown.
example: []
syntax:
content: public static void ConfigureJwtAuthentication(this WebApplicationBuilder builder)
parameters:
- id: builder
type: Microsoft.AspNetCore.Builder.WebApplicationBuilder
description: The <xref href="Microsoft.AspNetCore.Builder.WebApplicationBuilder" data-throw-if-not-resolved="false"></xref> to which authentication and authorization services are added.
content.vb: Public Shared Sub ConfigureJwtAuthentication(builder As WebApplicationBuilder)
overload: adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication*
exceptions:
- type: System.Exception
commentId: T:System.Exception
description: Thrown when the JWT signing key is not configured in the application settings.
references:
- uid: adas_core.Configurations
commentId: N:adas_core.Configurations
href: adas_core.html
name: adas_core.Configurations
nameWithType: adas_core.Configurations
fullName: adas_core.Configurations
spec.csharp:
- uid: adas_core
name: adas_core
href: adas_core.html
- name: .
- uid: adas_core.Configurations
name: Configurations
href: adas_core.Configurations.html
spec.vb:
- uid: adas_core
name: adas_core
href: adas_core.html
- name: .
- uid: adas_core.Configurations
name: Configurations
href: adas_core.Configurations.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: Microsoft.AspNetCore.Builder.WebApplicationBuilder
commentId: T:Microsoft.AspNetCore.Builder.WebApplicationBuilder
parent: Microsoft.AspNetCore.Builder
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.builder.webapplicationbuilder
name: WebApplicationBuilder
nameWithType: WebApplicationBuilder
fullName: Microsoft.AspNetCore.Builder.WebApplicationBuilder
- uid: adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections*
commentId: Overload:adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections
href: adas_core.Configurations.ServiceExtension.html#adas_core_Configurations_ServiceExtension_CreateConfigEntitiesFromAppSettingsSections_Microsoft_AspNetCore_Builder_WebApplicationBuilder_
name: CreateConfigEntitiesFromAppSettingsSections
nameWithType: ServiceExtension.CreateConfigEntitiesFromAppSettingsSections
fullName: adas_core.Configurations.ServiceExtension.CreateConfigEntitiesFromAppSettingsSections
- uid: Microsoft.AspNetCore.Builder
commentId: N:Microsoft.AspNetCore.Builder
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft
name: Microsoft.AspNetCore.Builder
nameWithType: Microsoft.AspNetCore.Builder
fullName: Microsoft.AspNetCore.Builder
spec.csharp:
- uid: Microsoft
name: Microsoft
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft
- name: .
- uid: Microsoft.AspNetCore
name: AspNetCore
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore
- name: .
- uid: Microsoft.AspNetCore.Builder
name: Builder
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.builder
spec.vb:
- uid: Microsoft
name: Microsoft
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft
- name: .
- uid: Microsoft.AspNetCore
name: AspNetCore
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore
- name: .
- uid: Microsoft.AspNetCore.Builder
name: Builder
isExternal: true
href: https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.builder
- uid: adas_core.module.ProxyDevices.ProxyDeviceSettings
commentId: T:adas_core.module.ProxyDevices.ProxyDeviceSettings
href: adas_core.module.ProxyDevices.ProxyDeviceSettings.html
name: ProxyDeviceSettings
nameWithType: ProxyDeviceSettings
fullName: adas_core.module.ProxyDevices.ProxyDeviceSettings
- uid: System.ArgumentNullException
commentId: T:System.ArgumentNullException
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.argumentnullexception
name: ArgumentNullException
nameWithType: ArgumentNullException
fullName: System.ArgumentNullException
- uid: adas_core.Configurations.ServiceExtension.UseProxyDevices*
commentId: Overload:adas_core.Configurations.ServiceExtension.UseProxyDevices
href: adas_core.Configurations.ServiceExtension.html#adas_core_Configurations_ServiceExtension_UseProxyDevices_Microsoft_AspNetCore_Builder_WebApplicationBuilder_
name: UseProxyDevices
nameWithType: ServiceExtension.UseProxyDevices
fullName: adas_core.Configurations.ServiceExtension.UseProxyDevices
- uid: System.Exception
commentId: T:System.Exception
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.exception
name: Exception
nameWithType: Exception
fullName: System.Exception
- uid: adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication*
commentId: Overload:adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication
href: adas_core.Configurations.ServiceExtension.html#adas_core_Configurations_ServiceExtension_ConfigureJwtAuthentication_Microsoft_AspNetCore_Builder_WebApplicationBuilder_
name: ConfigureJwtAuthentication
nameWithType: ServiceExtension.ConfigureJwtAuthentication
fullName: adas_core.Configurations.ServiceExtension.ConfigureJwtAuthentication