1. Packages
  2. Azure Native v2
  3. API Docs
  4. appconfiguration
  5. getConfigurationStore
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

azure-native-v2.appconfiguration.getConfigurationStore

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

Gets the properties of the specified configuration store. Azure REST API version: 2023-03-01.

Other available API versions: 2023-08-01-preview, 2023-09-01-preview, 2024-05-01.

Using getConfigurationStore

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConfigurationStore(args: GetConfigurationStoreArgs, opts?: InvokeOptions): Promise<GetConfigurationStoreResult>
function getConfigurationStoreOutput(args: GetConfigurationStoreOutputArgs, opts?: InvokeOptions): Output<GetConfigurationStoreResult>
Copy
def get_configuration_store(config_store_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetConfigurationStoreResult
def get_configuration_store_output(config_store_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetConfigurationStoreResult]
Copy
func LookupConfigurationStore(ctx *Context, args *LookupConfigurationStoreArgs, opts ...InvokeOption) (*LookupConfigurationStoreResult, error)
func LookupConfigurationStoreOutput(ctx *Context, args *LookupConfigurationStoreOutputArgs, opts ...InvokeOption) LookupConfigurationStoreResultOutput
Copy

> Note: This function is named LookupConfigurationStore in the Go SDK.

public static class GetConfigurationStore 
{
    public static Task<GetConfigurationStoreResult> InvokeAsync(GetConfigurationStoreArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigurationStoreResult> Invoke(GetConfigurationStoreInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConfigurationStoreResult> getConfigurationStore(GetConfigurationStoreArgs args, InvokeOptions options)
public static Output<GetConfigurationStoreResult> getConfigurationStore(GetConfigurationStoreArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:appconfiguration:getConfigurationStore
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConfigStoreName
This property is required.
Changes to this property will trigger replacement.
string
The name of the configuration store.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the container registry belongs.
ConfigStoreName
This property is required.
Changes to this property will trigger replacement.
string
The name of the configuration store.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the container registry belongs.
configStoreName
This property is required.
Changes to this property will trigger replacement.
String
The name of the configuration store.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to which the container registry belongs.
configStoreName
This property is required.
Changes to this property will trigger replacement.
string
The name of the configuration store.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the container registry belongs.
config_store_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the configuration store.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group to which the container registry belongs.
configStoreName
This property is required.
Changes to this property will trigger replacement.
String
The name of the configuration store.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to which the container registry belongs.

getConfigurationStore Result

The following output properties are available:

CreationDate string
The creation date of configuration store.
Endpoint string
The DNS endpoint where the configuration store API will be available.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrivateEndpointConnections List<Pulumi.AzureNative.AppConfiguration.Outputs.PrivateEndpointConnectionReferenceResponse>
The list of private endpoint connections that are set up for this resource.
ProvisioningState string
The provisioning state of the configuration store.
Sku Pulumi.AzureNative.AppConfiguration.Outputs.SkuResponse
The sku of the configuration store.
SystemData Pulumi.AzureNative.AppConfiguration.Outputs.SystemDataResponse
Resource system metadata.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DisableLocalAuth bool
Disables all authentication methods other than AAD authentication.
EnablePurgeProtection bool
Property specifying whether protection against purge is enabled for this configuration store.
Encryption Pulumi.AzureNative.AppConfiguration.Outputs.EncryptionPropertiesResponse
The encryption settings of the configuration store.
Identity Pulumi.AzureNative.AppConfiguration.Outputs.ResourceIdentityResponse
The managed identity information, if configured.
PublicNetworkAccess string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
SoftDeleteRetentionInDays int
The amount of time in days that the configuration store will be retained when it is soft deleted.
Tags Dictionary<string, string>
Resource tags.
CreationDate string
The creation date of configuration store.
Endpoint string
The DNS endpoint where the configuration store API will be available.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrivateEndpointConnections []PrivateEndpointConnectionReferenceResponse
The list of private endpoint connections that are set up for this resource.
ProvisioningState string
The provisioning state of the configuration store.
Sku SkuResponse
The sku of the configuration store.
SystemData SystemDataResponse
Resource system metadata.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DisableLocalAuth bool
Disables all authentication methods other than AAD authentication.
EnablePurgeProtection bool
Property specifying whether protection against purge is enabled for this configuration store.
Encryption EncryptionPropertiesResponse
The encryption settings of the configuration store.
Identity ResourceIdentityResponse
The managed identity information, if configured.
PublicNetworkAccess string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
SoftDeleteRetentionInDays int
The amount of time in days that the configuration store will be retained when it is soft deleted.
Tags map[string]string
Resource tags.
creationDate String
The creation date of configuration store.
endpoint String
The DNS endpoint where the configuration store API will be available.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
privateEndpointConnections List<PrivateEndpointConnectionReferenceResponse>
The list of private endpoint connections that are set up for this resource.
provisioningState String
The provisioning state of the configuration store.
sku SkuResponse
The sku of the configuration store.
systemData SystemDataResponse
Resource system metadata.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disableLocalAuth Boolean
Disables all authentication methods other than AAD authentication.
enablePurgeProtection Boolean
Property specifying whether protection against purge is enabled for this configuration store.
encryption EncryptionPropertiesResponse
The encryption settings of the configuration store.
identity ResourceIdentityResponse
The managed identity information, if configured.
publicNetworkAccess String
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
softDeleteRetentionInDays Integer
The amount of time in days that the configuration store will be retained when it is soft deleted.
tags Map<String,String>
Resource tags.
creationDate string
The creation date of configuration store.
endpoint string
The DNS endpoint where the configuration store API will be available.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
privateEndpointConnections PrivateEndpointConnectionReferenceResponse[]
The list of private endpoint connections that are set up for this resource.
provisioningState string
The provisioning state of the configuration store.
sku SkuResponse
The sku of the configuration store.
systemData SystemDataResponse
Resource system metadata.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disableLocalAuth boolean
Disables all authentication methods other than AAD authentication.
enablePurgeProtection boolean
Property specifying whether protection against purge is enabled for this configuration store.
encryption EncryptionPropertiesResponse
The encryption settings of the configuration store.
identity ResourceIdentityResponse
The managed identity information, if configured.
publicNetworkAccess string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
softDeleteRetentionInDays number
The amount of time in days that the configuration store will be retained when it is soft deleted.
tags {[key: string]: string}
Resource tags.
creation_date str
The creation date of configuration store.
endpoint str
The DNS endpoint where the configuration store API will be available.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
private_endpoint_connections Sequence[PrivateEndpointConnectionReferenceResponse]
The list of private endpoint connections that are set up for this resource.
provisioning_state str
The provisioning state of the configuration store.
sku SkuResponse
The sku of the configuration store.
system_data SystemDataResponse
Resource system metadata.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disable_local_auth bool
Disables all authentication methods other than AAD authentication.
enable_purge_protection bool
Property specifying whether protection against purge is enabled for this configuration store.
encryption EncryptionPropertiesResponse
The encryption settings of the configuration store.
identity ResourceIdentityResponse
The managed identity information, if configured.
public_network_access str
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
soft_delete_retention_in_days int
The amount of time in days that the configuration store will be retained when it is soft deleted.
tags Mapping[str, str]
Resource tags.
creationDate String
The creation date of configuration store.
endpoint String
The DNS endpoint where the configuration store API will be available.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
privateEndpointConnections List<Property Map>
The list of private endpoint connections that are set up for this resource.
provisioningState String
The provisioning state of the configuration store.
sku Property Map
The sku of the configuration store.
systemData Property Map
Resource system metadata.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disableLocalAuth Boolean
Disables all authentication methods other than AAD authentication.
enablePurgeProtection Boolean
Property specifying whether protection against purge is enabled for this configuration store.
encryption Property Map
The encryption settings of the configuration store.
identity Property Map
The managed identity information, if configured.
publicNetworkAccess String
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
softDeleteRetentionInDays Number
The amount of time in days that the configuration store will be retained when it is soft deleted.
tags Map<String>
Resource tags.

Supporting Types

EncryptionPropertiesResponse

keyVaultProperties Property Map
Key vault properties.

KeyVaultPropertiesResponse

IdentityClientId string
The client id of the identity which will be used to access key vault.
KeyIdentifier string
The URI of the key vault key used to encrypt data.
IdentityClientId string
The client id of the identity which will be used to access key vault.
KeyIdentifier string
The URI of the key vault key used to encrypt data.
identityClientId String
The client id of the identity which will be used to access key vault.
keyIdentifier String
The URI of the key vault key used to encrypt data.
identityClientId string
The client id of the identity which will be used to access key vault.
keyIdentifier string
The URI of the key vault key used to encrypt data.
identity_client_id str
The client id of the identity which will be used to access key vault.
key_identifier str
The URI of the key vault key used to encrypt data.
identityClientId String
The client id of the identity which will be used to access key vault.
keyIdentifier String
The URI of the key vault key used to encrypt data.

PrivateEndpointConnectionReferenceResponse

Id This property is required. string
The resource ID.
Name This property is required. string
The name of the resource.
PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.AppConfiguration.Inputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning status of the private endpoint connection.
Type This property is required. string
The type of the resource.
PrivateEndpoint Pulumi.AzureNative.AppConfiguration.Inputs.PrivateEndpointResponse
The resource of private endpoint.
Id This property is required. string
The resource ID.
Name This property is required. string
The name of the resource.
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning status of the private endpoint connection.
Type This property is required. string
The type of the resource.
PrivateEndpoint PrivateEndpointResponse
The resource of private endpoint.
id This property is required. String
The resource ID.
name This property is required. String
The name of the resource.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning status of the private endpoint connection.
type This property is required. String
The type of the resource.
privateEndpoint PrivateEndpointResponse
The resource of private endpoint.
id This property is required. string
The resource ID.
name This property is required. string
The name of the resource.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. string
The provisioning status of the private endpoint connection.
type This property is required. string
The type of the resource.
privateEndpoint PrivateEndpointResponse
The resource of private endpoint.
id This property is required. str
The resource ID.
name This property is required. str
The name of the resource.
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioning_state This property is required. str
The provisioning status of the private endpoint connection.
type This property is required. str
The type of the resource.
private_endpoint PrivateEndpointResponse
The resource of private endpoint.
id This property is required. String
The resource ID.
name This property is required. String
The name of the resource.
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning status of the private endpoint connection.
type This property is required. String
The type of the resource.
privateEndpoint Property Map
The resource of private endpoint.

PrivateEndpointResponse

Id string
The resource Id for private endpoint
Id string
The resource Id for private endpoint
id String
The resource Id for private endpoint
id string
The resource Id for private endpoint
id str
The resource Id for private endpoint
id String
The resource Id for private endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired This property is required. String
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String
The private link service connection description.
status String
The private link service connection status.
actionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description string
The private link service connection description.
status string
The private link service connection status.
actions_required This property is required. str
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description str
The private link service connection description.
status str
The private link service connection status.
actionsRequired This property is required. String
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String
The private link service connection description.
status String
The private link service connection status.

ResourceIdentityResponse

PrincipalId This property is required. string
The principal id of the identity. This property will only be provided for a system-assigned identity.
TenantId This property is required. string
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
Type string
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.AppConfiguration.Inputs.UserIdentityResponse>
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
PrincipalId This property is required. string
The principal id of the identity. This property will only be provided for a system-assigned identity.
TenantId This property is required. string
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
Type string
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
UserAssignedIdentities map[string]UserIdentityResponse
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the identity. This property will only be provided for a system-assigned identity.
tenantId This property is required. String
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
type String
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
userAssignedIdentities Map<String,UserIdentityResponse>
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. string
The principal id of the identity. This property will only be provided for a system-assigned identity.
tenantId This property is required. string
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
type string
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
userAssignedIdentities {[key: string]: UserIdentityResponse}
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principal_id This property is required. str
The principal id of the identity. This property will only be provided for a system-assigned identity.
tenant_id This property is required. str
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
type str
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
user_assigned_identities Mapping[str, UserIdentityResponse]
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the identity. This property will only be provided for a system-assigned identity.
tenantId This property is required. String
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
type String
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
userAssignedIdentities Map<Property Map>
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

SkuResponse

Name This property is required. string
The SKU name of the configuration store.
Name This property is required. string
The SKU name of the configuration store.
name This property is required. String
The SKU name of the configuration store.
name This property is required. string
The SKU name of the configuration store.
name This property is required. str
The SKU name of the configuration store.
name This property is required. String
The SKU name of the configuration store.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserIdentityResponse

ClientId This property is required. string
The client ID of the user-assigned identity.
PrincipalId This property is required. string
The principal ID of the user-assigned identity.
ClientId This property is required. string
The client ID of the user-assigned identity.
PrincipalId This property is required. string
The principal ID of the user-assigned identity.
clientId This property is required. String
The client ID of the user-assigned identity.
principalId This property is required. String
The principal ID of the user-assigned identity.
clientId This property is required. string
The client ID of the user-assigned identity.
principalId This property is required. string
The principal ID of the user-assigned identity.
client_id This property is required. str
The client ID of the user-assigned identity.
principal_id This property is required. str
The principal ID of the user-assigned identity.
clientId This property is required. String
The client ID of the user-assigned identity.
principalId This property is required. String
The principal ID of the user-assigned identity.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi