CloudServiceRoleInstanceResource Class

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.6.0

Source:

CloudServiceRoleInstanceResource.cs

A Class representing a CloudServiceRoleInstance along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CloudServiceRoleInstanceResource from an instance of ArmClient using the GetCloudServiceRoleInstanceResource method. Otherwise you can get one from its parent resource CloudServiceResource using the GetCloudServiceRoleInstance method.

public class CloudServiceRoleInstanceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.CloudServiceRoleInstanceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.CloudServiceRoleInstanceData>

type CloudServiceRoleInstanceResource = class
    inherit ArmResource
    interface IJsonModel<CloudServiceRoleInstanceData>
    interface IPersistableModel<CloudServiceRoleInstanceData>

Public Class CloudServiceRoleInstanceResource
Inherits ArmResource
Implements IJsonModel(Of CloudServiceRoleInstanceData), IPersistableModel(Of CloudServiceRoleInstanceData)

Inheritance

Object

ArmResource

CloudServiceRoleInstanceResource

Implements

IJsonModel<CloudServiceRoleInstanceData> IPersistableModel<CloudServiceRoleInstanceData> IPersistableModel<T>

Constructors

CloudServiceRoleInstanceResource()

Initializes a new instance of the CloudServiceRoleInstanceResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

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

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, String)	Generate the resource identifier of a CloudServiceRoleInstanceResource instance.
Delete(WaitUntil, CancellationToken)	Deletes a role instance from a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName} Operation Id: CloudServiceRoleInstances_Delete Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
DeleteAsync(WaitUntil, CancellationToken)	Deletes a role instance from a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName} Operation Id: CloudServiceRoleInstances_Delete Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
Get(Nullable<InstanceViewType>, CancellationToken)	Gets a role instance from a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName} Operation Id: CloudServiceRoleInstances_Get Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
GetAsync(Nullable<InstanceViewType>, CancellationToken)	Gets a role instance from a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName} Operation Id: CloudServiceRoleInstances_Get Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetInstanceView(CancellationToken)	Retrieves information about the run-time state of a role instance in a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/instanceView Operation Id: CloudServiceRoleInstances_GetInstanceView Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
GetInstanceViewAsync(CancellationToken)	Retrieves information about the run-time state of a role instance in a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/instanceView Operation Id: CloudServiceRoleInstances_GetInstanceView Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetRemoteDesktopFile(CancellationToken)	Gets a remote desktop file for a role instance in a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/remoteDesktopFile Operation Id: CloudServiceRoleInstances_GetRemoteDesktopFile Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
GetRemoteDesktopFileAsync(CancellationToken)	Gets a remote desktop file for a role instance in a cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/remoteDesktopFile Operation Id: CloudServiceRoleInstances_GetRemoteDesktopFile Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
Rebuild(WaitUntil, CancellationToken)	The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/rebuild Operation Id: CloudServiceRoleInstances_Rebuild Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
RebuildAsync(WaitUntil, CancellationToken)	The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/rebuild Operation Id: CloudServiceRoleInstances_Rebuild Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
Reimage(WaitUntil, CancellationToken)	The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/reimage Operation Id: CloudServiceRoleInstances_Reimage Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
ReimageAsync(WaitUntil, CancellationToken)	The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/reimage Operation Id: CloudServiceRoleInstances_Reimage Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
Restart(WaitUntil, CancellationToken)	The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/restart Operation Id: CloudServiceRoleInstances_Restart Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
RestartAsync(WaitUntil, CancellationToken)	The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/restart Operation Id: CloudServiceRoleInstances_Restart Default Api Version: 2022-09-04 Resource: CloudServiceRoleInstanceResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)

Explicit Interface Implementations

IJsonModel<CloudServiceRoleInstanceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CloudServiceRoleInstanceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<CloudServiceRoleInstanceData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CloudServiceRoleInstanceData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CloudServiceRoleInstanceData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.