Watch Aspire live streamsDocsTry Aspire

SqlServerProxy

Handle
📦 Aspire.Hosting.Azure.Provisioning.Sql v13.6.0-preview.1.26478.8
interface SqlServerProxy {
administratorLogin: BicepValueProxy | string;
administratorLoginPassword: BicepValueProxy | string;
administrators: ServerExternalAdministratorProxy;
readonly externalGovernanceStatus: BicepValueProxy | ExternalGovernanceStatus;
federatedClientId: BicepValueProxy | guid;
readonly fullyQualifiedDomainName: BicepValueProxy | string;
readonly id: BicepValueProxy;
identity: SqlManagedServiceIdentityProxy;
isIPv6Enabled: BicepValueProxy | ServerNetworkAccessFlag;
keyId: BicepValueProxy | uri;
readonly kind: BicepValueProxy | string;
location: BicepValueProxy;
minTlsVersion: BicepValueProxy | SqlMinimalTlsVersion;
name: BicepValueProxy | string;
primaryUserAssignedIdentityId: BicepValueProxy;
readonly privateEndpointConnections: Aspire_Hosting_Azure_Provisioning_Sql_Generated_ListOfSqlServerPrivateEndpointConnectionProxy;
publicNetworkAccess: BicepValueProxy | ServerNetworkAccessFlag;
restrictOutboundNetworkAccess: BicepValueProxy | ServerNetworkAccessFlag;
readonly state: BicepValueProxy | string;
readonly systemData: SqlSystemDataProxy;
tags: Aspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfStringProxy;
version: BicepValueProxy | string;
readonly workspaceFeature: BicepValueProxy | ServerWorkspaceFeature;
addTo(infrastructure: AzureResourceInfrastructure): void;
clearAdministratorLogin(): void;
clearAdministratorLoginPassword(): void;
clearFederatedClientId(): void;
clearIsIPv6Enabled(): void;
clearKeyId(): void;
clearLocation(): void;
clearMinTlsVersion(): void;
clearName(): void;
clearPrimaryUserAssignedIdentityId(): void;
clearPublicNetworkAccess(): void;
clearRestrictOutboundNetworkAccess(): void;
clearVersion(): void;
createRoleAssignment(
role: SqlBuiltInRoleProxy,
principalType: BicepValueProxy | RoleManagementPrincipalType,
principalId: BicepValueProxy | guid,
bicepIdentifierSuffix: string): SqlRoleAssignmentProxy;
}

Properties

propertyadministratorLoginBicepValueProxy | stringget · set
Gets or sets the AdministratorLogin provisioning property.
propertyadministratorLoginPasswordBicepValueProxy | stringget · set
Gets or sets the AdministratorLoginPassword provisioning property.
propertyadministratorsServerExternalAdministratorProxyget · set
Gets or sets the Administrators provisioning property.
propertyexternalGovernanceStatusBicepValueProxy | ExternalGovernanceStatusget
Gets the ExternalGovernanceStatus provisioning property.
propertyfederatedClientIdBicepValueProxy | guidget · set
Gets or sets the FederatedClientId provisioning property.
propertyfullyQualifiedDomainNameBicepValueProxy | stringget
Gets the FullyQualifiedDomainName provisioning property.
propertyidBicepValueProxyget
Gets the Id provisioning property.
propertyidentitySqlManagedServiceIdentityProxyget · set
Gets or sets the Identity provisioning property.
propertyisIPv6EnabledBicepValueProxy | ServerNetworkAccessFlagget · set
Gets or sets the IsIPv6Enabled provisioning property.
propertykeyIdBicepValueProxy | uriget · set
Gets or sets the KeyId provisioning property.
propertykindBicepValueProxy | stringget
Gets the Kind provisioning property.
propertylocationBicepValueProxyget · set
Gets or sets the Location provisioning property.
propertyminTlsVersionBicepValueProxy | SqlMinimalTlsVersionget · set
Gets or sets the MinTlsVersion provisioning property.
propertynameBicepValueProxy | stringget · set
Gets or sets the Name provisioning property.
propertyprimaryUserAssignedIdentityIdBicepValueProxyget · set
Gets or sets the PrimaryUserAssignedIdentityId provisioning property.
propertyprivateEndpointConnectionsAspire_Hosting_Azure_Provisioning_Sql_Generated_ListOfSqlServerPrivateEndpointConnectionProxyget
Gets the PrivateEndpointConnections provisioning property.
propertypublicNetworkAccessBicepValueProxy | ServerNetworkAccessFlagget · set
Gets or sets the PublicNetworkAccess provisioning property.
propertyrestrictOutboundNetworkAccessBicepValueProxy | ServerNetworkAccessFlagget · set
Gets or sets the RestrictOutboundNetworkAccess provisioning property.
propertystateBicepValueProxy | stringget
Gets the State provisioning property.
propertysystemDataSqlSystemDataProxyget
Gets the SystemData provisioning property.
propertytagsAspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfStringProxyget · set
Gets or sets the Tags provisioning property.
propertyversionBicepValueProxy | stringget · set
Gets or sets the Version provisioning property.
propertyworkspaceFeatureBicepValueProxy | ServerWorkspaceFeatureget
Gets the WorkspaceFeature provisioning property.

Methods

methodaddTo
Adds this provisioning resource to the Azure resource infrastructure.
addTo(infrastructure: AzureResourceInfrastructure): void
infrastructureAzureResourceInfrastructure
Clears the AdministratorLogin provisioning property.
clearAdministratorLogin(): void
Clears the AdministratorLoginPassword provisioning property.
clearAdministratorLoginPassword(): void
Clears the FederatedClientId provisioning property.
clearFederatedClientId(): void
Clears the IsIPv6Enabled provisioning property.
clearIsIPv6Enabled(): void
Clears the KeyId provisioning property.
clearKeyId(): void
Clears the Location provisioning property.
clearLocation(): void
Clears the MinTlsVersion provisioning property.
clearMinTlsVersion(): void
methodclearName
Clears the Name provisioning property.
clearName(): void
Clears the PrimaryUserAssignedIdentityId provisioning property.
clearPrimaryUserAssignedIdentityId(): void
Clears the PublicNetworkAccess provisioning property.
clearPublicNetworkAccess(): void
Clears the RestrictOutboundNetworkAccess provisioning property.
clearRestrictOutboundNetworkAccess(): void
Clears the Version provisioning property.
clearVersion(): void
Invokes CreateRoleAssignment on the SqlServer provisioning model.
createRoleAssignment(
role: SqlBuiltInRoleProxy,
principalType: BicepValueProxy | RoleManagementPrincipalType,
principalId: BicepValueProxy | guid,
bicepIdentifierSuffix: string): SqlRoleAssignmentProxy
roleSqlBuiltInRoleProxy
principalTypeBicepValueProxy | RoleManagementPrincipalType
principalIdBicepValueProxy | guid
bicepIdentifierSuffixstring
SqlRoleAssignmentProxy