Interface ConfigurationStore
public interface ConfigurationStore
An immutable client-side representation of ConfigurationStore.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the ConfigurationStore definition.static interface
The ConfigurationStore definition stages.static interface
The template for ConfigurationStore update.static interface
The ConfigurationStore update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the createMode property: Indicates whether the configuration store need to be recovered.Gets the creationDate property: The creation date of configuration store.Gets the disableLocalAuth property: Disables all authentication methods other than AAD authentication.Gets the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this configuration store.Gets the encryption property: The encryption settings of the configuration store.endpoint()
Gets the endpoint property: The DNS endpoint where the configuration store API will be available.id()
Gets the id property: Fully qualified resource Id for the resource.identity()
Gets the identity property: The managed identity information, if configured.Gets the inner com.azure.resourcemanager.appconfiguration.fluent.models.ConfigurationStoreInner object.com.azure.core.http.rest.PagedIterable<ApiKey>
listKeys()
Lists the access key for the specified configuration store.com.azure.core.http.rest.PagedIterable<ApiKey>
Lists the access key for the specified configuration store.location()
Gets the location property: The geo-location where the resource lives.name()
Gets the name property: The name of the resource.Gets the privateEndpointConnections property: The list of private endpoint connections that are set up for this resource.Gets the provisioningState property: The provisioning state of the configuration store.Gets the publicNetworkAccess property: Control permission for data plane traffic coming from public networks while private endpoint is enabled.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.regenerateKey
(RegenerateKeyParameters regenerateKeyParameters) Regenerates an access key for the specified configuration store.com.azure.core.http.rest.Response<ApiKey>
regenerateKeyWithResponse
(RegenerateKeyParameters regenerateKeyParameters, com.azure.core.util.Context context) Regenerates an access key for the specified configuration store.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.sku()
Gets the sku property: The sku of the configuration store.Gets the softDeleteRetentionInDays property: The amount of time in days that the configuration store will be retained when it is soft deleted.com.azure.core.management.SystemData
Gets the systemData property: Resource system metadata.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.update()
Begins update for the ConfigurationStore resource.
-
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.
-
identity
ResourceIdentity identity()Gets the identity property: The managed identity information, if configured.- Returns:
- the identity value.
-
sku
Sku sku()Gets the sku property: The sku of the configuration store.- Returns:
- the sku value.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Resource system metadata.- Returns:
- the systemData value.
-
provisioningState
ProvisioningState provisioningState()Gets the provisioningState property: The provisioning state of the configuration store.- Returns:
- the provisioningState value.
-
creationDate
OffsetDateTime creationDate()Gets the creationDate property: The creation date of configuration store.- Returns:
- the creationDate value.
-
endpoint
String endpoint()Gets the endpoint property: The DNS endpoint where the configuration store API will be available.- Returns:
- the endpoint value.
-
encryption
EncryptionProperties encryption()Gets the encryption property: The encryption settings of the configuration store.- Returns:
- the encryption value.
-
privateEndpointConnections
List<PrivateEndpointConnectionReference> privateEndpointConnections()Gets the privateEndpointConnections property: The list of private endpoint connections that are set up for this resource.- Returns:
- the privateEndpointConnections value.
-
publicNetworkAccess
PublicNetworkAccess publicNetworkAccess()Gets the publicNetworkAccess property: Control permission for data plane traffic coming from public networks while private endpoint is enabled.- Returns:
- the publicNetworkAccess value.
-
disableLocalAuth
Boolean disableLocalAuth()Gets the disableLocalAuth property: Disables all authentication methods other than AAD authentication.- Returns:
- the disableLocalAuth value.
-
softDeleteRetentionInDays
Integer softDeleteRetentionInDays()Gets the softDeleteRetentionInDays property: The amount of time in days that the configuration store will be retained when it is soft deleted.- Returns:
- the softDeleteRetentionInDays value.
-
enablePurgeProtection
Boolean enablePurgeProtection()Gets the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this configuration store.- Returns:
- the enablePurgeProtection value.
-
createMode
CreateMode createMode()Gets the createMode property: Indicates whether the configuration store need to be recovered.- Returns:
- the createMode 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
ConfigurationStoreInner innerModel()Gets the inner com.azure.resourcemanager.appconfiguration.fluent.models.ConfigurationStoreInner object.- Returns:
- the inner object.
-
update
ConfigurationStore.Update update()Begins update for the ConfigurationStore resource.- Returns:
- the stage of resource update.
-
refresh
ConfigurationStore 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.
-
listKeys
com.azure.core.http.rest.PagedIterable<ApiKey> listKeys()Lists the access key for the specified configuration store.- Returns:
- the result of a request to list API keys as paginated response with
PagedIterable
. - 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.
-
listKeys
com.azure.core.http.rest.PagedIterable<ApiKey> listKeys(String skipToken, com.azure.core.util.Context context) Lists the access key for the specified configuration store.- Parameters:
skipToken
- A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.context
- The context to associate with this operation.- Returns:
- the result of a request to list API keys as paginated response with
PagedIterable
. - 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.
-
regenerateKey
Regenerates an access key for the specified configuration store.- Parameters:
regenerateKeyParameters
- The parameters for regenerating an access key.- Returns:
- an API key used for authenticating with a configuration store endpoint.
- 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.
-
regenerateKeyWithResponse
com.azure.core.http.rest.Response<ApiKey> regenerateKeyWithResponse(RegenerateKeyParameters regenerateKeyParameters, com.azure.core.util.Context context) Regenerates an access key for the specified configuration store.- Parameters:
regenerateKeyParameters
- The parameters for regenerating an access key.context
- The context to associate with this operation.- Returns:
- an API key used for authenticating with a configuration store endpoint 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.
-