# SqlServerProxy

- Module: [Aspire.Hosting.Azure.Provisioning.Sql](/reference/api/typescript/aspire.hosting.azure.provisioning.sql.md)
- Version: `13.6.0-preview.1.26478.8`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62)

Represents the SqlServer Azure Provisioning model.

## Definition

```typescript
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

- `administratorLogin`: `BicepValueProxy | string` `get - set` -- Gets or sets the AdministratorLogin provisioning property.
- `administratorLoginPassword`: `BicepValueProxy | string` `get - set` -- Gets or sets the AdministratorLoginPassword provisioning property.
- `administrators`: [ServerExternalAdministratorProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/serverexternaladministratorproxy.md) `get - set` -- Gets or sets the Administrators provisioning property.
- `externalGovernanceStatus`: `BicepValueProxy | ExternalGovernanceStatus` `get` -- Gets the ExternalGovernanceStatus provisioning property.
- `federatedClientId`: `BicepValueProxy | guid` `get - set` -- Gets or sets the FederatedClientId provisioning property.
- `fullyQualifiedDomainName`: `BicepValueProxy | string` `get` -- Gets the FullyQualifiedDomainName provisioning property.
- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `identity`: [SqlManagedServiceIdentityProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlmanagedserviceidentityproxy.md) `get - set` -- Gets or sets the Identity provisioning property.
- `isIPv6Enabled`: `BicepValueProxy | ServerNetworkAccessFlag` `get - set` -- Gets or sets the IsIPv6Enabled provisioning property.
- `keyId`: `BicepValueProxy | uri` `get - set` -- Gets or sets the KeyId provisioning property.
- `kind`: `BicepValueProxy | string` `get` -- Gets the Kind provisioning property.
- `location`: `BicepValueProxy` `get - set` -- Gets or sets the Location provisioning property.
- `minTlsVersion`: `BicepValueProxy | SqlMinimalTlsVersion` `get - set` -- Gets or sets the MinTlsVersion provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `primaryUserAssignedIdentityId`: `BicepValueProxy` `get - set` -- Gets or sets the PrimaryUserAssignedIdentityId provisioning property.
- `privateEndpointConnections`: [Aspire_Hosting_Azure_Provisioning_Sql_Generated_ListOfSqlServerPrivateEndpointConnectionProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/aspire-hosting-azure-provisioning-sql-generated-listofsqlserverprivateendpointconnectionproxy.md) `get` -- Gets the PrivateEndpointConnections provisioning property.
- `publicNetworkAccess`: `BicepValueProxy | ServerNetworkAccessFlag` `get - set` -- Gets or sets the PublicNetworkAccess provisioning property.
- `restrictOutboundNetworkAccess`: `BicepValueProxy | ServerNetworkAccessFlag` `get - set` -- Gets or sets the RestrictOutboundNetworkAccess provisioning property.
- `state`: `BicepValueProxy | string` `get` -- Gets the State provisioning property.
- `systemData`: [SqlSystemDataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlsystemdataproxy.md) `get` -- Gets the SystemData provisioning property.
- `tags`: [Aspire_Hosting_Azure_Provisioning_Sql_Generated_DictionaryOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/aspire-hosting-azure-provisioning-sql-generated-dictionaryofstringproxy.md) `get - set` -- Gets or sets the Tags provisioning property.
- `version`: `BicepValueProxy | string` `get - set` -- Gets or sets the Version provisioning property.
- `workspaceFeature`: `BicepValueProxy | ServerWorkspaceFeature` `get` -- Gets the WorkspaceFeature provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearAdministratorLogin](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearadministratorlogin.md) -- `method` -- Clears the AdministratorLogin provisioning property.
    ```typescript
  clearAdministratorLogin(): void
  ```
- [clearAdministratorLoginPassword](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearadministratorloginpassword.md) -- `method` -- Clears the AdministratorLoginPassword provisioning property.
    ```typescript
  clearAdministratorLoginPassword(): void
  ```
- [clearFederatedClientId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearfederatedclientid.md) -- `method` -- Clears the FederatedClientId provisioning property.
    ```typescript
  clearFederatedClientId(): void
  ```
- [clearIsIPv6Enabled](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearisipv6enabled.md) -- `method` -- Clears the IsIPv6Enabled provisioning property.
    ```typescript
  clearIsIPv6Enabled(): void
  ```
- [clearKeyId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearkeyid.md) -- `method` -- Clears the KeyId provisioning property.
    ```typescript
  clearKeyId(): void
  ```
- [clearLocation](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearlocation.md) -- `method` -- Clears the Location provisioning property.
    ```typescript
  clearLocation(): void
  ```
- [clearMinTlsVersion](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearmintlsversion.md) -- `method` -- Clears the MinTlsVersion provisioning property.
    ```typescript
  clearMinTlsVersion(): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearPrimaryUserAssignedIdentityId](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearprimaryuserassignedidentityid.md) -- `method` -- Clears the PrimaryUserAssignedIdentityId provisioning property.
    ```typescript
  clearPrimaryUserAssignedIdentityId(): void
  ```
- [clearPublicNetworkAccess](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearpublicnetworkaccess.md) -- `method` -- Clears the PublicNetworkAccess provisioning property.
    ```typescript
  clearPublicNetworkAccess(): void
  ```
- [clearRestrictOutboundNetworkAccess](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearrestrictoutboundnetworkaccess.md) -- `method` -- Clears the RestrictOutboundNetworkAccess provisioning property.
    ```typescript
  clearRestrictOutboundNetworkAccess(): void
  ```
- [clearVersion](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/clearversion.md) -- `method` -- Clears the Version provisioning property.
    ```typescript
  clearVersion(): void
  ```
- [createRoleAssignment](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlserverproxy/createroleassignment.md) -- `method` -- Invokes CreateRoleAssignment on the SqlServer provisioning model.
    ```typescript
  createRoleAssignment(role: SqlBuiltInRoleProxy, principalType: BicepValueProxy | RoleManagementPrincipalType, principalId: BicepValueProxy | guid, bicepIdentifierSuffix: string): SqlRoleAssignmentProxy
  ```