AvsPrivateCloudResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Avs
Assembly:
Azure.ResourceManager.Avs.dll
Package:
Azure.ResourceManager.Avs v1.3.0
Package:
Azure.ResourceManager.Avs v1.2.0-beta.1
Source:
AvsPrivateCloudResource.cs
Source:
AvsPrivateCloudResource.cs

A Class representing an AvsPrivateCloud along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an AvsPrivateCloudResource from an instance of ArmClient using the GetAvsPrivateCloudResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetAvsPrivateCloud method.

public class AvsPrivateCloudResource : Azure.ResourceManager.ArmResource
type AvsPrivateCloudResource = class
    inherit ArmResource
Public Class AvsPrivateCloudResource
Inherits ArmResource
Inheritance
Object
ArmResource
AvsPrivateCloudResource

Constructors

AvsPrivateCloudResource()

Initializes a new instance of the AvsPrivateCloudResource 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

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
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 of a AvsPrivateCloudResource instance.
Delete(WaitUntil, CancellationToken)

Delete a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Delete
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
DeleteAsync(WaitUntil, CancellationToken)

Delete a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Delete
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
Get(CancellationToken)

Get a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
GetAdminCredentials(CancellationToken)

List the admin credentials for the private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials
  • Operation Id: PrivateClouds_ListAdminCredentials
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
GetAdminCredentialsAsync(CancellationToken)

List the admin credentials for the private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials
  • Operation Id: PrivateClouds_ListAdminCredentials
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
GetAsync(CancellationToken)

Get a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvsCloudLink(String, CancellationToken)

Get an cloud link by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}
  • Operation Id: CloudLinks_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsCloudLinkResource
GetAvsCloudLinkAsync(String, CancellationToken)

Get an cloud link by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}
  • Operation Id: CloudLinks_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsCloudLinkResource
GetAvsCloudLinks()

Gets a collection of AvsCloudLinkResources in the AvsPrivateCloud.
GetAvsPrivateCloudAddon(String, CancellationToken)

Get an addon by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
  • Operation Id: Addons_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudAddonResource
GetAvsPrivateCloudAddonAsync(String, CancellationToken)

Get an addon by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
  • Operation Id: Addons_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudAddonResource
GetAvsPrivateCloudAddons()

Gets a collection of AvsPrivateCloudAddonResources in the AvsPrivateCloud.
GetAvsPrivateCloudCluster(String, CancellationToken)

Get a cluster by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudClusterResource
GetAvsPrivateCloudClusterAsync(String, CancellationToken)

Get a cluster by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudClusterResource
GetAvsPrivateCloudClusters()

Gets a collection of AvsPrivateCloudClusterResources in the AvsPrivateCloud.
GetExpressRouteAuthorization(String, CancellationToken)

Get an ExpressRoute Circuit Authorization by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
  • Operation Id: Authorizations_Get
  • Default Api Version: 2023-03-01
  • Resource: ExpressRouteAuthorizationResource
GetExpressRouteAuthorizationAsync(String, CancellationToken)

Get an ExpressRoute Circuit Authorization by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
  • Operation Id: Authorizations_Get
  • Default Api Version: 2023-03-01
  • Resource: ExpressRouteAuthorizationResource
GetExpressRouteAuthorizations()

Gets a collection of ExpressRouteAuthorizationResources in the AvsPrivateCloud.
GetGlobalReachConnection(String, CancellationToken)

Get a global reach connection by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
  • Operation Id: GlobalReachConnections_Get
  • Default Api Version: 2023-03-01
  • Resource: GlobalReachConnectionResource
GetGlobalReachConnectionAsync(String, CancellationToken)

Get a global reach connection by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
  • Operation Id: GlobalReachConnections_Get
  • Default Api Version: 2023-03-01
  • Resource: GlobalReachConnectionResource
GetGlobalReachConnections()

Gets a collection of GlobalReachConnectionResources in the AvsPrivateCloud.
GetHcxEnterpriseSite(String, CancellationToken)

Get an HCX on-premises key by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
  • Operation Id: HcxEnterpriseSites_Get
  • Default Api Version: 2023-03-01
  • Resource: HcxEnterpriseSiteResource
GetHcxEnterpriseSiteAsync(String, CancellationToken)

Get an HCX on-premises key by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
  • Operation Id: HcxEnterpriseSites_Get
  • Default Api Version: 2023-03-01
  • Resource: HcxEnterpriseSiteResource
GetHcxEnterpriseSites()

Gets a collection of HcxEnterpriseSiteResources in the AvsPrivateCloud.
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)
GetScriptExecution(String, CancellationToken)

Get an script execution by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}
  • Operation Id: ScriptExecutions_Get
  • Default Api Version: 2023-03-01
  • Resource: ScriptExecutionResource
GetScriptExecutionAsync(String, CancellationToken)

Get an script execution by name in a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}
  • Operation Id: ScriptExecutions_Get
  • Default Api Version: 2023-03-01
  • Resource: ScriptExecutionResource
GetScriptExecutions()

Gets a collection of ScriptExecutionResources in the AvsPrivateCloud.
GetScriptPackage(String, CancellationToken)

Get a script package available to run on a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}
  • Operation Id: ScriptPackages_Get
  • Default Api Version: 2023-03-01
  • Resource: ScriptPackageResource
GetScriptPackageAsync(String, CancellationToken)

Get a script package available to run on a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}
  • Operation Id: ScriptPackages_Get
  • Default Api Version: 2023-03-01
  • Resource: ScriptPackageResource
GetScriptPackages()

Gets a collection of ScriptPackageResources in the AvsPrivateCloud.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetWorkloadNetwork(WorkloadNetworkName, CancellationToken)

Get a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/{workloadNetworkName}
  • Operation Id: WorkloadNetworks_Get
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkResource
GetWorkloadNetworkAsync(WorkloadNetworkName, CancellationToken)

Get a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/{workloadNetworkName}
  • Operation Id: WorkloadNetworks_Get
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkResource
GetWorkloadNetworkDhcp(String, CancellationToken)

Get dhcp by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
  • Operation Id: WorkloadNetworks_GetDhcp
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkDhcpResource
GetWorkloadNetworkDhcpAsync(String, CancellationToken)

Get dhcp by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
  • Operation Id: WorkloadNetworks_GetDhcp
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkDhcpResource
GetWorkloadNetworkDhcps()

Gets a collection of WorkloadNetworkDhcpResources in the AvsPrivateCloud.
GetWorkloadNetworkDnsService(String, CancellationToken)

Get a DNS service by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
  • Operation Id: WorkloadNetworks_GetDnsService
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkDnsServiceResource
GetWorkloadNetworkDnsServiceAsync(String, CancellationToken)

Get a DNS service by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
  • Operation Id: WorkloadNetworks_GetDnsService
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkDnsServiceResource
GetWorkloadNetworkDnsServices()

Gets a collection of WorkloadNetworkDnsServiceResources in the AvsPrivateCloud.
GetWorkloadNetworkDnsZone(String, CancellationToken)

Get a DNS zone by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
  • Operation Id: WorkloadNetworks_GetDnsZone
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkDnsZoneResource
GetWorkloadNetworkDnsZoneAsync(String, CancellationToken)

Get a DNS zone by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
  • Operation Id: WorkloadNetworks_GetDnsZone
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkDnsZoneResource
GetWorkloadNetworkDnsZones()

Gets a collection of WorkloadNetworkDnsZoneResources in the AvsPrivateCloud.
GetWorkloadNetworkGateway(String, CancellationToken)

Get a gateway by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}
  • Operation Id: WorkloadNetworks_GetGateway
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkGatewayResource
GetWorkloadNetworkGatewayAsync(String, CancellationToken)

Get a gateway by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}
  • Operation Id: WorkloadNetworks_GetGateway
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkGatewayResource
GetWorkloadNetworkGateways()

Gets a collection of WorkloadNetworkGatewayResources in the AvsPrivateCloud.
GetWorkloadNetworkPortMirroringProfile(String, CancellationToken)

Get a port mirroring profile by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
  • Operation Id: WorkloadNetworks_GetPortMirroring
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkPortMirroringProfileResource
GetWorkloadNetworkPortMirroringProfileAsync(String, CancellationToken)

Get a port mirroring profile by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
  • Operation Id: WorkloadNetworks_GetPortMirroring
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkPortMirroringProfileResource
GetWorkloadNetworkPortMirroringProfiles()

Gets a collection of WorkloadNetworkPortMirroringProfileResources in the AvsPrivateCloud.
GetWorkloadNetworkPublicIP(String, CancellationToken)

Get a Public IP Block by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}
  • Operation Id: WorkloadNetworks_GetPublicIP
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkPublicIPResource
GetWorkloadNetworkPublicIPAsync(String, CancellationToken)

Get a Public IP Block by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}
  • Operation Id: WorkloadNetworks_GetPublicIP
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkPublicIPResource
GetWorkloadNetworkPublicIPs()

Gets a collection of WorkloadNetworkPublicIPResources in the AvsPrivateCloud.
GetWorkloadNetworks()

Gets a collection of WorkloadNetworkResources in the AvsPrivateCloud.
GetWorkloadNetworkSegment(String, CancellationToken)

Get a segment by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
  • Operation Id: WorkloadNetworks_GetSegment
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkSegmentResource
GetWorkloadNetworkSegmentAsync(String, CancellationToken)

Get a segment by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
  • Operation Id: WorkloadNetworks_GetSegment
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkSegmentResource
GetWorkloadNetworkSegments()

Gets a collection of WorkloadNetworkSegmentResources in the AvsPrivateCloud.
GetWorkloadNetworkVirtualMachine(String, CancellationToken)

Get a virtual machine by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}
  • Operation Id: WorkloadNetworks_GetVirtualMachine
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkVirtualMachineResource
GetWorkloadNetworkVirtualMachineAsync(String, CancellationToken)

Get a virtual machine by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}
  • Operation Id: WorkloadNetworks_GetVirtualMachine
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkVirtualMachineResource
GetWorkloadNetworkVirtualMachines()

Gets a collection of WorkloadNetworkVirtualMachineResources in the AvsPrivateCloud.
GetWorkloadNetworkVmGroup(String, CancellationToken)

Get a vm group by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
  • Operation Id: WorkloadNetworks_GetVMGroup
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkVmGroupResource
GetWorkloadNetworkVmGroupAsync(String, CancellationToken)

Get a vm group by id in a private cloud workload network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
  • Operation Id: WorkloadNetworks_GetVMGroup
  • Default Api Version: 2023-03-01
  • Resource: WorkloadNetworkVmGroupResource
GetWorkloadNetworkVmGroups()

Gets a collection of WorkloadNetworkVmGroupResources in the AvsPrivateCloud.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
RotateNsxtPassword(WaitUntil, CancellationToken)

Rotate the NSX-T Manager password

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateNsxtPassword
  • Operation Id: PrivateClouds_RotateNsxtPassword
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
RotateNsxtPasswordAsync(WaitUntil, CancellationToken)

Rotate the NSX-T Manager password

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateNsxtPassword
  • Operation Id: PrivateClouds_RotateNsxtPassword
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
RotateVCenterPassword(WaitUntil, CancellationToken)

Rotate the vCenter password

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateVcenterPassword
  • Operation Id: PrivateClouds_RotateVcenterPassword
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
RotateVCenterPasswordAsync(WaitUntil, CancellationToken)

Rotate the vCenter password

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateVcenterPassword
  • Operation Id: PrivateClouds_RotateVcenterPassword
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Get
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, AvsPrivateCloudPatch, CancellationToken)

Update a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Update
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource
UpdateAsync(WaitUntil, AvsPrivateCloudPatch, CancellationToken)

Update a private cloud

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
  • Operation Id: PrivateClouds_Update
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudResource

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.

Applies to