ConnectionProperties interface

Package:

@azure/arm-chaos

Model that represents the properties of a connection.

The schema is flat and discriminated by kind. Optional fields form the superset across all connection kinds; which fields are required is validated by the service per kind.

Properties

certificateIssuer	The issuer of the certificate used to authenticate the connection.
certificateSubjectName	The subject name of the certificate used to authenticate the connection.
dataPlaneEndpoint	The regional Chaos Studio data-plane endpoint assigned to this connection. Clients and agents use this endpoint to reach the Chaos Studio data plane for the connection.
dstsPrincipal	The dSTS principal name used to authenticate the connection.
kind	The kind of connection, indicating the actor type authorized to reach the Chaos Studio data plane for the workspace and target.
principalId	The Microsoft Entra principal (object) ID of the identity used by the connection.
provisioningState	The most recent provisioning state for the connection resource.
status	The current status of the connection.
targetResourceId	The fully qualified Azure resource ID of the target resource this connection is established with.
tenantId	The Microsoft Entra tenant ID that the connection identity belongs to.

Property Details

certificateIssuer

The issuer of the certificate used to authenticate the connection.

certificateIssuer?: string

Property Value

string

certificateSubjectName

The subject name of the certificate used to authenticate the connection.

certificateSubjectName?: string

Property Value

string

dataPlaneEndpoint

The regional Chaos Studio data-plane endpoint assigned to this connection. Clients and agents use this endpoint to reach the Chaos Studio data plane for the connection.

dataPlaneEndpoint?: string

Property Value

string

dstsPrincipal

The dSTS principal name used to authenticate the connection.

dstsPrincipal?: string

Property Value

string

kind

The kind of connection, indicating the actor type authorized to reach the Chaos Studio data plane for the workspace and target.

kind: string

Property Value

string

principalId

The Microsoft Entra principal (object) ID of the identity used by the connection.

principalId?: string

Property Value

string

provisioningState

The most recent provisioning state for the connection resource.

provisioningState?: string

Property Value

string

status

The current status of the connection.

status?: string

Property Value

string

targetResourceId

The fully qualified Azure resource ID of the target resource this connection is established with.

targetResourceId: string

Property Value

string

tenantId

The Microsoft Entra tenant ID that the connection identity belongs to.

tenantId?: string

Property Value

string