Interface PrivateCloud
public interface PrivateCloud
An immutable client-side representation of PrivateCloud.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the PrivateCloud definition.static interface
The PrivateCloud definition stages.static interface
The template for PrivateCloud update.static interface
The PrivateCloud update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the availability property: Properties describing how the cloud is distributed across availability zones.circuit()
Gets the circuit property: An ExpressRoute Circuit.Gets the encryption property: Customer managed key encryption, can be enabled or disabled.Gets the endpoints property: The endpoints.Gets the externalCloudLinks property: Array of cloud link IDs from other clouds that connect to this one.id()
Gets the id property: Fully qualified resource Id for the resource.identity()
Gets the identity property: The identity of the private cloud, if configured.Gets the identitySources property: vCenter Single Sign On Identity Sources.Gets the inner com.azure.resourcemanager.avs.fluent.models.PrivateCloudInner object.internet()
Gets the internet property: Connectivity to internet is enabled or disabled.List the admin credentials for the private cloud.com.azure.core.http.rest.Response<AdminCredentials>
listAdminCredentialsWithResponse
(com.azure.core.util.Context context) List the admin credentials for the private cloud.location()
Gets the location property: The geo-location where the resource lives.Gets the managementCluster property: The default cluster used for management.Gets the managementNetwork property: Network used to access vCenter Server and NSX-T Manager.name()
Gets the name property: The name of the resource.Gets the networkBlock property: The block of addresses should be unique across VNet in your subscription as well as on-premise.Gets the nsxPublicIpQuotaRaised property: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024.Gets the nsxtCertificateThumbprint property: Thumbprint of the NSX-T Manager SSL certificate.Gets the nsxtPassword property: Optionally, set the NSX-T Manager password when the private cloud is created.Gets the provisioningNetwork property: Used for virtual machine cold migration, cloning, and snapshot migration.Gets the provisioningState property: The provisioning state.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.void
Rotate the NSX-T Manager password.void
rotateNsxtPassword
(com.azure.core.util.Context context) Rotate the NSX-T Manager password.void
Rotate the vCenter password.void
rotateVcenterPassword
(com.azure.core.util.Context context) Rotate the vCenter password.Gets the secondaryCircuit property: A secondary expressRoute circuit from a separate AZ.sku()
Gets the sku property: The private cloud SKU.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.update()
Begins update for the PrivateCloud resource.Gets the vcenterCertificateThumbprint property: Thumbprint of the vCenter Server SSL certificate.Gets the vcenterPassword property: Optionally, set the vCenter admin password when the private cloud is created.Gets the vmotionNetwork property: Used for live migration of virtual machines.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
sku
Sku sku()Gets the sku property: The private cloud SKU.- Returns:
- the sku value.
-
identity
PrivateCloudIdentity identity()Gets the identity property: The identity of the private cloud, if configured.- Returns:
- the identity value.
-
provisioningState
PrivateCloudProvisioningState provisioningState()Gets the provisioningState property: The provisioning state.- Returns:
- the provisioningState value.
-
circuit
Circuit circuit()Gets the circuit property: An ExpressRoute Circuit.- Returns:
- the circuit value.
-
endpoints
Endpoints endpoints()Gets the endpoints property: The endpoints.- Returns:
- the endpoints value.
-
networkBlock
String networkBlock()Gets the networkBlock property: The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22.- Returns:
- the networkBlock value.
-
managementNetwork
String managementNetwork()Gets the managementNetwork property: Network used to access vCenter Server and NSX-T Manager.- Returns:
- the managementNetwork value.
-
provisioningNetwork
String provisioningNetwork()Gets the provisioningNetwork property: Used for virtual machine cold migration, cloning, and snapshot migration.- Returns:
- the provisioningNetwork value.
-
vmotionNetwork
String vmotionNetwork()Gets the vmotionNetwork property: Used for live migration of virtual machines.- Returns:
- the vmotionNetwork value.
-
vcenterPassword
String vcenterPassword()Gets the vcenterPassword property: Optionally, set the vCenter admin password when the private cloud is created.- Returns:
- the vcenterPassword value.
-
nsxtPassword
String nsxtPassword()Gets the nsxtPassword property: Optionally, set the NSX-T Manager password when the private cloud is created.- Returns:
- the nsxtPassword value.
-
vcenterCertificateThumbprint
String vcenterCertificateThumbprint()Gets the vcenterCertificateThumbprint property: Thumbprint of the vCenter Server SSL certificate.- Returns:
- the vcenterCertificateThumbprint value.
-
nsxtCertificateThumbprint
String nsxtCertificateThumbprint()Gets the nsxtCertificateThumbprint property: Thumbprint of the NSX-T Manager SSL certificate.- Returns:
- the nsxtCertificateThumbprint value.
-
externalCloudLinks
Gets the externalCloudLinks property: Array of cloud link IDs from other clouds that connect to this one.- Returns:
- the externalCloudLinks value.
-
secondaryCircuit
Circuit secondaryCircuit()Gets the secondaryCircuit property: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud.- Returns:
- the secondaryCircuit value.
-
nsxPublicIpQuotaRaised
NsxPublicIpQuotaRaisedEnum nsxPublicIpQuotaRaised()Gets the nsxPublicIpQuotaRaised property: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024.- Returns:
- the nsxPublicIpQuotaRaised value.
-
managementCluster
ManagementCluster managementCluster()Gets the managementCluster property: The default cluster used for management.- Returns:
- the managementCluster value.
-
internet
InternetEnum internet()Gets the internet property: Connectivity to internet is enabled or disabled.- Returns:
- the internet value.
-
identitySources
List<IdentitySource> identitySources()Gets the identitySources property: vCenter Single Sign On Identity Sources.- Returns:
- the identitySources value.
-
availability
AvailabilityProperties availability()Gets the availability property: Properties describing how the cloud is distributed across availability zones.- Returns:
- the availability value.
-
encryption
Encryption encryption()Gets the encryption property: Customer managed key encryption, can be enabled or disabled.- Returns:
- the encryption value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
PrivateCloudInner innerModel()Gets the inner com.azure.resourcemanager.avs.fluent.models.PrivateCloudInner object.- Returns:
- the inner object.
-
update
PrivateCloud.Update update()Begins update for the PrivateCloud resource.- Returns:
- the stage of resource update.
-
refresh
PrivateCloud refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
rotateVcenterPassword
void rotateVcenterPassword()Rotate the vCenter password.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
rotateVcenterPassword
void rotateVcenterPassword(com.azure.core.util.Context context) Rotate the vCenter password.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
rotateNsxtPassword
void rotateNsxtPassword()Rotate the NSX-T Manager password.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
rotateNsxtPassword
void rotateNsxtPassword(com.azure.core.util.Context context) Rotate the NSX-T Manager password.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listAdminCredentialsWithResponse
com.azure.core.http.rest.Response<AdminCredentials> listAdminCredentialsWithResponse(com.azure.core.util.Context context) List the admin credentials for the private cloud.- Parameters:
context
- The context to associate with this operation.- Returns:
- administrative credentials for accessing vCenter and NSX-T along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listAdminCredentials
AdminCredentials listAdminCredentials()List the admin credentials for the private cloud.- Returns:
- administrative credentials for accessing vCenter and NSX-T.
- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-