CognitiveServicesConnectionProperties Class
Definition
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.
Connection property base schema. Please note 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 AadAuthTypeConnectionProperties, AccessKeyAuthTypeConnectionProperties, AccountKeyAuthTypeConnectionProperties, ApiKeyAuthConnectionProperties, CustomKeysConnectionProperties, ManagedIdentityAuthTypeConnectionProperties, NoneAuthTypeConnectionProperties, OAuth2AuthTypeConnectionProperties, PatAuthTypeConnectionProperties, SASAuthTypeConnectionProperties, ServicePrincipalAuthTypeConnectionProperties and UsernamePasswordAuthTypeConnectionProperties.
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.CognitiveServices.Models.UnknownConnectionPropertiesV2))]
public abstract class CognitiveServicesConnectionProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesConnectionProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesConnectionProperties>[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.CognitiveServices.Models.UnknownConnectionPropertiesV2))>]
type CognitiveServicesConnectionProperties = class
interface IJsonModel<CognitiveServicesConnectionProperties>
interface IPersistableModel<CognitiveServicesConnectionProperties>Public MustInherit Class CognitiveServicesConnectionProperties
Implements IJsonModel(Of CognitiveServicesConnectionProperties), IPersistableModel(Of CognitiveServicesConnectionProperties)- Inheritance
-
CognitiveServicesConnectionProperties
- Derived
- Attributes
- Implements
Constructors
| CognitiveServicesConnectionProperties() |
Initializes a new instance of CognitiveServicesConnectionProperties. |
Properties
| 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
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<CognitiveServicesConnectionProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<CognitiveServicesConnectionProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<CognitiveServicesConnectionProperties>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<CognitiveServicesConnectionProperties>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<CognitiveServicesConnectionProperties>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
