AvailabilityGroupCollection Class
Displays a collection of specified objects in the availability group.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
Microsoft.SqlServer.Management.Smo.SmoCollectionBase
Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
Microsoft.SqlServer.Management.Smo.AvailabilityGroupCollection
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public NotInheritable Class AvailabilityGroupCollection _
Inherits SimpleObjectCollectionBase
'Usage
Dim instance As AvailabilityGroupCollection
public sealed class AvailabilityGroupCollection : SimpleObjectCollectionBase
public ref class AvailabilityGroupCollection sealed : public SimpleObjectCollectionBase
[<SealedAttribute>]
type AvailabilityGroupCollection =
class
inherit SimpleObjectCollectionBase
end
public final class AvailabilityGroupCollection extends SimpleObjectCollectionBase
The AvailabilityGroupCollection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Count | Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.) |
|
IsSynchronized | Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.) |
|
Item[Int32] | Gets an AvailabilityGroup object in the collection by index number. |
|
Item[String] | Gets an AvailabilityGroup object in the collection by name. |
|
Parent | Gets the parent of the AvailabilityGroupCollection object. |
|
SyncRoot | Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Add | Adds the specified availability group to the collection. |
.gif "Protected method") |
AddExisting | Adds an object to the collection. (Inherited from AbstractCollectionBase.) |
|
Contains | Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.) |
|
CopyTo | Copies the current availability group collection to the specified availability group array at the specified index. |
|
Equals | (Inherited from Object.) |
|
GetEnumerator | Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
ItemById | Extracts a member from the availability group collection using a system-defined, unique identifier. |
|
Refresh() | Refreshes the referenced collection. (Inherited from SmoCollectionBase.) |
|
Refresh(Boolean) | Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.) |
|
Remove(String) | Removes an availability group from the collection with specified name. |
|
Remove(AvailabilityGroup) | Removes the specified availability group from the collection. |
|
ToString | (Inherited from Object.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
initialized | This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICollection.CopyTo | Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.) |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.