HostPoolResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Class representing a HostPool along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a HostPoolResource from an instance of ArmClient using the GetHostPoolResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetHostPool method.
public class HostPoolResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DesktopVirtualization.HostPoolData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DesktopVirtualization.HostPoolData>type HostPoolResource = class
inherit ArmResource
interface IJsonModel<HostPoolData>
interface IPersistableModel<HostPoolData>Public Class HostPoolResource
Inherits ArmResource
Implements IJsonModel(Of HostPoolData), IPersistableModel(Of HostPoolData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| HostPoolResource() |
Initializes a new instance of HostPoolResource for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource. |
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource. |
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, Nullable<Boolean>, CancellationToken) |
Remove a host pool.
|
| DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Remove a host pool.
|
| ExpandMsixImages(MsixImageUri, CancellationToken) |
Expands and Lists MSIX packages in an Image, given the Image Path. This action uses incorrect Msix casing intentionally to match the previous APIs.
|
| ExpandMsixImagesAsync(MsixImageUri, CancellationToken) |
Expands and Lists MSIX packages in an Image, given the Image Path. This action uses incorrect Msix casing intentionally to match the previous APIs.
|
| Get(CancellationToken) |
Get a host pool.
|
| GetActiveSessionHostConfiguration() |
Gets an object representing a ActiveSessionHostConfigurationResource along with the instance operations that can be performed on it in the HostPoolResource. |
| GetAsync(CancellationToken) |
Get a host pool.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetByHostPool(CancellationToken) |
Operation to list the ActiveSessionHostConfigurations associated with the HostPool
|
| GetByHostPoolAsync(CancellationToken) |
Operation to list the ActiveSessionHostConfigurations associated with the HostPool
|
| GetHostPoolPrivateEndpointConnection(String, CancellationToken) |
Get a PrivateEndpointConnectionWithSystemData. |
| GetHostPoolPrivateEndpointConnectionAsync(String, CancellationToken) |
Get a PrivateEndpointConnectionWithSystemData. |
| GetHostPoolPrivateEndpointConnections() |
Gets a collection of HostPoolPrivateEndpointConnections in the HostPoolResource. |
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetMsixPackage(String, CancellationToken) |
Get a msixpackage. |
| GetMsixPackageAsync(String, CancellationToken) |
Get a msixpackage. |
| GetMsixPackages() |
Gets a collection of MsixPackages in the HostPoolResource. |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetPrivateLinkResources(Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) |
List the private link resources available for this hostpool.
|
| GetPrivateLinkResourcesAsync(Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) |
List the private link resources available for this hostpool.
|
| GetRegistrationTokens(CancellationToken) |
Operation to list the RegistrationTokens associated with the HostPool.
|
| GetRegistrationTokensAsync(CancellationToken) |
Operation to list the RegistrationTokens associated with the HostPool.
|
| GetScalingPlans(Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) |
List scaling plan associated with hostpool.
|
| GetScalingPlansAsync(Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) |
List scaling plan associated with hostpool.
|
| GetSessionHost(String, CancellationToken) |
Get a session host. |
| GetSessionHostAsync(String, CancellationToken) |
Get a session host. |
| GetSessionHostConfiguration() |
Gets an object representing a SessionHostConfigurationResource along with the instance operations that can be performed on it in the HostPoolResource. |
| GetSessionHostManagement() |
Gets an object representing a SessionHostManagementResource along with the instance operations that can be performed on it in the HostPoolResource. |
| GetSessionHosts() |
Gets a collection of SessionHosts in the HostPoolResource. |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| GetUserSessions(String, CancellationToken) |
List userSessions.
|
| GetUserSessions(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) |
A synchronous resource action.
|
| GetUserSessionsAsync(String, CancellationToken) |
List userSessions.
|
| GetUserSessionsAsync(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) |
A synchronous resource action.
|
| ImportAppAttachPackageInfos(ImportPackageInfoContent, CancellationToken) |
Gets information from a package given the path to the package.
|
| ImportAppAttachPackageInfosAsync(ImportPackageInfoContent, CancellationToken) |
Gets information from a package given the path to the package.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| RetrieveRegistrationToken(CancellationToken) |
Registration token of the host pool.
|
| RetrieveRegistrationTokenAsync(CancellationToken) |
Registration token of the host pool.
|
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(HostPoolPatch, CancellationToken) |
Update a host pool.
|
| UpdateAsync(HostPoolPatch, CancellationToken) |
Update a host pool.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<HostPoolData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<HostPoolData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<HostPoolData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<HostPoolData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<HostPoolData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
