# InstanceFailoverGroupProxy

- 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 InstanceFailoverGroup Azure Provisioning model.

## Definition

```typescript
interface InstanceFailoverGroupProxy {
  readonly id: BicepValueProxy;
  managedInstancePairs: Aspire_Hosting_Azure_Provisioning_Sql_Generated_ListOfManagedInstancePairInfoProxy;
  name: BicepValueProxy | string;
  partnerRegions: Aspire_Hosting_Azure_Provisioning_Sql_Generated_ListOfPartnerRegionInfoProxy;
  readOnlyEndpointFailoverPolicy: BicepValueProxy | ReadOnlyEndpointFailoverPolicy;
  readWriteEndpoint: InstanceFailoverGroupReadWriteEndpointProxy;
  readonly replicationRole: BicepValueProxy | InstanceFailoverGroupReplicationRole;
  readonly replicationState: BicepValueProxy | string;
  secondaryType: BicepValueProxy | GeoSecondaryInstanceType;
  readonly systemData: SqlSystemDataProxy;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearName(): void;
  clearReadOnlyEndpointFailoverPolicy(): void;
  clearSecondaryType(): void;
}
```

## Properties

- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `managedInstancePairs`: [Aspire_Hosting_Azure_Provisioning_Sql_Generated_ListOfManagedInstancePairInfoProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/aspire-hosting-azure-provisioning-sql-generated-listofmanagedinstancepairinfoproxy.md) `get - set` -- Gets or sets the ManagedInstancePairs provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `partnerRegions`: [Aspire_Hosting_Azure_Provisioning_Sql_Generated_ListOfPartnerRegionInfoProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/aspire-hosting-azure-provisioning-sql-generated-listofpartnerregioninfoproxy.md) `get - set` -- Gets or sets the PartnerRegions provisioning property.
- `readOnlyEndpointFailoverPolicy`: `BicepValueProxy | ReadOnlyEndpointFailoverPolicy` `get - set` -- Gets or sets the ReadOnlyEndpointFailoverPolicy provisioning property.
- `readWriteEndpoint`: [InstanceFailoverGroupReadWriteEndpointProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/instancefailovergroupreadwriteendpointproxy.md) `get - set` -- Gets or sets the ReadWriteEndpoint provisioning property.
- `replicationRole`: `BicepValueProxy | InstanceFailoverGroupReplicationRole` `get` -- Gets the ReplicationRole provisioning property.
- `replicationState`: `BicepValueProxy | string` `get` -- Gets the ReplicationState provisioning property.
- `secondaryType`: `BicepValueProxy | GeoSecondaryInstanceType` `get - set` -- Gets or sets the SecondaryType provisioning property.
- `systemData`: [SqlSystemDataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/sqlsystemdataproxy.md) `get` -- Gets the SystemData provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/instancefailovergroupproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/instancefailovergroupproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearReadOnlyEndpointFailoverPolicy](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/instancefailovergroupproxy/clearreadonlyendpointfailoverpolicy.md) -- `method` -- Clears the ReadOnlyEndpointFailoverPolicy provisioning property.
    ```typescript
  clearReadOnlyEndpointFailoverPolicy(): void
  ```
- [clearSecondaryType](/reference/api/typescript/aspire.hosting.azure.provisioning.sql/instancefailovergroupproxy/clearsecondarytype.md) -- `method` -- Clears the SecondaryType provisioning property.
    ```typescript
  clearSecondaryType(): void
  ```