Share via

CognitiveServicesConnectionProperties Class

Definition

Namespace:
Azure.Provisioning.CognitiveServices
Assembly:
Azure.Provisioning.CognitiveServices.dll
Package:
Azure.Provisioning.CognitiveServices v1.2.0
Source:
CognitiveServicesConnectionProperties.cs

Connection property base schema. Please note Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesConnectionProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include Azure.ResourceManager.CognitiveServices.Models.AadAuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.AccessKeyAuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.AccountKeyAuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.ApiKeyAuthConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.CustomKeysConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.ManagedIdentityAuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.NoneAuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.OAuth2AuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.PatAuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.SASAuthTypeConnectionProperties, Azure.ResourceManager.CognitiveServices.Models.ServicePrincipalAuthTypeConnectionProperties and Azure.ResourceManager.CognitiveServices.Models.UsernamePasswordAuthTypeConnectionProperties.

public class CognitiveServicesConnectionProperties : Azure.Provisioning.Primitives.ProvisionableConstruct
type CognitiveServicesConnectionProperties = class
    inherit ProvisionableConstruct
Public Class CognitiveServicesConnectionProperties
Inherits ProvisionableConstruct
Inheritance
Object
Provisionable
ProvisionableConstruct
CognitiveServicesConnectionProperties
Derived

Constructors

Name Description
CognitiveServicesConnectionProperties()

Creates a new CognitiveServicesConnectionProperties.

Properties

Name Description
Category

Category of the connection.
CreatedByWorkspaceArmId

Gets the created by workspace arm id.
Error

Provides the error message if the connection fails.
ExpiryOn

Gets or sets the expiry on.
Group

Group based on connection category.
IsSharedToAll

Gets or sets the is shared to all.
Metadata

Store user metadata for this connection.
PeRequirement

Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'.
PeStatus

Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'.
SharedUserList

Gets the shared user list.
Target

The connection URL to be used.
UseWorkspaceManagedIdentity

Gets or sets the use workspace managed identity.

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 CognitiveServicesConnectionProperties.
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