SearchAadAuthDataPlaneAuthOptions Class

Definition

Namespace:: Azure.Provisioning.Search

Assembly:: Azure.Provisioning.Search.dll

Package:: Azure.Provisioning.Search v1.0.0

Package:: Azure.Provisioning.Search v1.1.0-beta.1

Source:: SearchAadAuthDataPlaneAuthOptions.cs

Source:: SearchAadAuthDataPlaneAuthOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true.

public class SearchAadAuthDataPlaneAuthOptions : Azure.Provisioning.Primitives.ProvisionableConstruct

type SearchAadAuthDataPlaneAuthOptions = class
    inherit ProvisionableConstruct

Public Class SearchAadAuthDataPlaneAuthOptions
Inherits ProvisionableConstruct

Inheritance: Object

Provisionable

ProvisionableConstruct
SearchAadAuthDataPlaneAuthOptions

Constructors

Name	Description
SearchAadAuthDataPlaneAuthOptions()	Creates a new SearchAadAuthDataPlaneAuthOptions.

Properties

Name Description

Name	Description
AadAuthFailureMode	Describes what response the data plane API of a search service would send for requests that failed authentication.
ApiKeyOnly	Indicates that only the API key can be used for authentication. To assign an object to this property use System.BinaryData.FromObjectAsJson`1(`0,System.Text.Json.JsonSerializerOptions). To assign an already formatted json string to this property use System.BinaryData.FromString(System.String). Examples: BinaryData.FromObjectAsJson("foo")Creates a payload of "foo".BinaryData.FromString(""foo"")Creates a payload of "foo".BinaryData.FromObjectAsJson(new { key = "value" })Creates a payload of { "key": "value" }.BinaryData.FromString("{"key": "value"}")Creates a payload of { "key": "value" }.

AadAuthFailureMode

Describes what response the data plane API of a search service would send for requests that failed authentication.

ApiKeyOnly

Indicates that only the API key can be used for authentication. To assign an object to this property use System.BinaryData.FromObjectAsJson1(0,System.Text.Json.JsonSerializerOptions). To assign an already formatted json string to this property use System.BinaryData.FromString(System.String). Examples: BinaryData.FromObjectAsJson("foo")Creates a payload of "foo".BinaryData.FromString(""foo"")Creates a payload of "foo".BinaryData.FromObjectAsJson(new { key = "value" })Creates a payload of { "key": "value" }.BinaryData.FromString("{"key": "value"}")Creates a payload of { "key": "value" }.

Methods

Name	Description
AssignOrReplace<T>(T, T)	(Inherited from ProvisionableConstruct)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from ProvisionableConstruct)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String)	(Inherited from ProvisionableConstruct)
DefineProvisionableProperties()	Define all the provisionable properties of SearchAadAuthDataPlaneAuthOptions.
GetProvisionableResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
Initialize()	Initialize this construct. (Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression)	(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)	Validate the presence of any required members. (Inherited from ProvisionableConstruct)

Explicit Interface Implementations

Name	Description
IBicepValue.Assign(IBicepValue)	Assign a value to this property. (Inherited from ProvisionableConstruct)
IBicepValue.Compile()	Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct)
IBicepValue.Expression	Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty	Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct)
IBicepValue.IsOutput	Tracks whether this is an output only property. (Inherited from ProvisionableConstruct)
IBicepValue.IsRequired	Tracks whether this property is required. (Inherited from ProvisionableConstruct)
IBicepValue.IsSecure	Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct)
IBicepValue.Kind	Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue	Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct)
IBicepValue.Self	Gets information about where this value was defined. (Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()	Make this value readonly. (Inherited from ProvisionableConstruct)
IBicepValue.Source	Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct)

Extension Methods

Name	Description
ToBicepExpression(IBicepValue)	Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to

Feedback

Was this page helpful?