com.azure.resourcemanager.netapp.models.NetAppAccount Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-netapp Show documentation
Show all versions of azure-resourcemanager-netapp Show documentation
This package contains Microsoft Azure SDK for NetAppFiles Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Microsoft NetApp Files Azure Resource Provider specification. Package tag package-2024-03.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.netapp.models;
import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.netapp.fluent.models.NetAppAccountInner;
import java.util.List;
import java.util.Map;
/**
* An immutable client-side representation of NetAppAccount.
*/
public interface NetAppAccount {
/**
* Gets the id property: Fully qualified resource Id for the resource.
*
* @return the id value.
*/
String id();
/**
* Gets the name property: The name of the resource.
*
* @return the name value.
*/
String name();
/**
* Gets the type property: The type of the resource.
*
* @return the type value.
*/
String type();
/**
* Gets the location property: The geo-location where the resource lives.
*
* @return the location value.
*/
String location();
/**
* Gets the tags property: Resource tags.
*
* @return the tags value.
*/
Map tags();
/**
* Gets the etag property: A unique read-only string that changes whenever the resource is updated.
*
* @return the etag value.
*/
String etag();
/**
* Gets the identity property: The identity used for the resource.
*
* @return the identity value.
*/
ManagedServiceIdentity identity();
/**
* Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
* @return the systemData value.
*/
SystemData systemData();
/**
* Gets the provisioningState property: Azure lifecycle management.
*
* @return the provisioningState value.
*/
String provisioningState();
/**
* Gets the activeDirectories property: Active Directories.
*
* @return the activeDirectories value.
*/
List activeDirectories();
/**
* Gets the encryption property: Encryption settings.
*
* @return the encryption value.
*/
AccountEncryption encryption();
/**
* Gets the disableShowmount property: Shows the status of disableShowmount for all volumes under the subscription,
* null equals false.
*
* @return the disableShowmount value.
*/
Boolean disableShowmount();
/**
* Gets the nfsV4IdDomain property: Domain for NFSv4 user ID mapping. This property will be set for all NetApp
* accounts in the subscription and region and only affect non ldap NFSv4 volumes.
*
* @return the nfsV4IdDomain value.
*/
String nfsV4IdDomain();
/**
* Gets the isMultiAdEnabled property: This will have true value only if account is Multiple AD enabled.
*
* @return the isMultiAdEnabled value.
*/
Boolean isMultiAdEnabled();
/**
* Gets the region of the resource.
*
* @return the region of the resource.
*/
Region region();
/**
* Gets the name of the resource region.
*
* @return the name of the resource region.
*/
String regionName();
/**
* Gets the name of the resource group.
*
* @return the name of the resource group.
*/
String resourceGroupName();
/**
* Gets the inner com.azure.resourcemanager.netapp.fluent.models.NetAppAccountInner object.
*
* @return the inner object.
*/
NetAppAccountInner innerModel();
/**
* The entirety of the NetAppAccount definition.
*/
interface Definition extends DefinitionStages.Blank, DefinitionStages.WithLocation,
DefinitionStages.WithResourceGroup, DefinitionStages.WithCreate {
}
/**
* The NetAppAccount definition stages.
*/
interface DefinitionStages {
/**
* The first stage of the NetAppAccount definition.
*/
interface Blank extends WithLocation {
}
/**
* The stage of the NetAppAccount definition allowing to specify location.
*/
interface WithLocation {
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(Region location);
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(String location);
}
/**
* The stage of the NetAppAccount definition allowing to specify parent resource.
*/
interface WithResourceGroup {
/**
* Specifies resourceGroupName.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @return the next definition stage.
*/
WithCreate withExistingResourceGroup(String resourceGroupName);
}
/**
* The stage of the NetAppAccount definition which contains all the minimum required properties for the resource
* to be created, but also allows for any other optional properties to be specified.
*/
interface WithCreate
extends DefinitionStages.WithTags, DefinitionStages.WithIdentity, DefinitionStages.WithActiveDirectories,
DefinitionStages.WithEncryption, DefinitionStages.WithNfsV4IdDomain {
/**
* Executes the create request.
*
* @return the created resource.
*/
NetAppAccount create();
/**
* Executes the create request.
*
* @param context The context to associate with this operation.
* @return the created resource.
*/
NetAppAccount create(Context context);
}
/**
* The stage of the NetAppAccount definition allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
WithCreate withTags(Map tags);
}
/**
* The stage of the NetAppAccount definition allowing to specify identity.
*/
interface WithIdentity {
/**
* Specifies the identity property: The identity used for the resource..
*
* @param identity The identity used for the resource.
* @return the next definition stage.
*/
WithCreate withIdentity(ManagedServiceIdentity identity);
}
/**
* The stage of the NetAppAccount definition allowing to specify activeDirectories.
*/
interface WithActiveDirectories {
/**
* Specifies the activeDirectories property: Active Directories.
*
* @param activeDirectories Active Directories.
* @return the next definition stage.
*/
WithCreate withActiveDirectories(List activeDirectories);
}
/**
* The stage of the NetAppAccount definition allowing to specify encryption.
*/
interface WithEncryption {
/**
* Specifies the encryption property: Encryption settings.
*
* @param encryption Encryption settings.
* @return the next definition stage.
*/
WithCreate withEncryption(AccountEncryption encryption);
}
/**
* The stage of the NetAppAccount definition allowing to specify nfsV4IdDomain.
*/
interface WithNfsV4IdDomain {
/**
* Specifies the nfsV4IdDomain property: Domain for NFSv4 user ID mapping. This property will be set for all
* NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes..
*
* @param nfsV4IdDomain Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts
* in the subscription and region and only affect non ldap NFSv4 volumes.
* @return the next definition stage.
*/
WithCreate withNfsV4IdDomain(String nfsV4IdDomain);
}
}
/**
* Begins update for the NetAppAccount resource.
*
* @return the stage of resource update.
*/
NetAppAccount.Update update();
/**
* The template for NetAppAccount update.
*/
interface Update extends UpdateStages.WithTags, UpdateStages.WithIdentity, UpdateStages.WithActiveDirectories,
UpdateStages.WithEncryption, UpdateStages.WithNfsV4IdDomain {
/**
* Executes the update request.
*
* @return the updated resource.
*/
NetAppAccount apply();
/**
* Executes the update request.
*
* @param context The context to associate with this operation.
* @return the updated resource.
*/
NetAppAccount apply(Context context);
}
/**
* The NetAppAccount update stages.
*/
interface UpdateStages {
/**
* The stage of the NetAppAccount update allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
Update withTags(Map tags);
}
/**
* The stage of the NetAppAccount update allowing to specify identity.
*/
interface WithIdentity {
/**
* Specifies the identity property: The identity used for the resource..
*
* @param identity The identity used for the resource.
* @return the next definition stage.
*/
Update withIdentity(ManagedServiceIdentity identity);
}
/**
* The stage of the NetAppAccount update allowing to specify activeDirectories.
*/
interface WithActiveDirectories {
/**
* Specifies the activeDirectories property: Active Directories.
*
* @param activeDirectories Active Directories.
* @return the next definition stage.
*/
Update withActiveDirectories(List activeDirectories);
}
/**
* The stage of the NetAppAccount update allowing to specify encryption.
*/
interface WithEncryption {
/**
* Specifies the encryption property: Encryption settings.
*
* @param encryption Encryption settings.
* @return the next definition stage.
*/
Update withEncryption(AccountEncryption encryption);
}
/**
* The stage of the NetAppAccount update allowing to specify nfsV4IdDomain.
*/
interface WithNfsV4IdDomain {
/**
* Specifies the nfsV4IdDomain property: Domain for NFSv4 user ID mapping. This property will be set for all
* NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes..
*
* @param nfsV4IdDomain Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts
* in the subscription and region and only affect non ldap NFSv4 volumes.
* @return the next definition stage.
*/
Update withNfsV4IdDomain(String nfsV4IdDomain);
}
}
/**
* Refreshes the resource to sync with Azure.
*
* @return the refreshed resource.
*/
NetAppAccount refresh();
/**
* Refreshes the resource to sync with Azure.
*
* @param context The context to associate with this operation.
* @return the refreshed resource.
*/
NetAppAccount refresh(Context context);
/**
* Renew identity credentials
*
* Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If
* encryption.identity.principalId does not match identity.principalId, running this operation will fix it.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void renewCredentials();
/**
* Renew identity credentials
*
* Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If
* encryption.identity.principalId does not match identity.principalId, running this operation will fix it.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void renewCredentials(Context context);
/**
* Transition volumes encryption from PMK to CMK.
*
* Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key
* Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void transitionToCmk();
/**
* Transition volumes encryption from PMK to CMK.
*
* Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key
* Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.
*
* @param body The required parameters to perform encryption transition.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void transitionToCmk(EncryptionTransitionRequest body, Context context);
/**
* Get information about how volumes under NetApp account are encrypted.
*
* Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by
* each encryption sibling set. Response from this endpoint can be modified and used as request body for POST
* request.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void getChangeKeyVaultInformation();
/**
* Get information about how volumes under NetApp account are encrypted.
*
* Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by
* each encryption sibling set. Response from this endpoint can be modified and used as request body for POST
* request.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void getChangeKeyVaultInformation(Context context);
/**
* Change Key Vault/Managed HSM that is used for encryption of volumes under NetApp account.
*
* Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key
* Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void changeKeyVault();
/**
* Change Key Vault/Managed HSM that is used for encryption of volumes under NetApp account.
*
* Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key
* Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.
*
* @param body The required parameters to perform encryption migration.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void changeKeyVault(ChangeKeyVault body, Context context);
}