Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. cognitiveservices
  5. getEncryptionScope
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.cognitiveservices.getEncryptionScope

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified EncryptionScope associated with the Cognitive Services account. Azure REST API version: 2023-10-01-preview.

Other available API versions: 2024-04-01-preview, 2024-06-01-preview, 2024-10-01.

Using getEncryptionScope

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 getEncryptionScope(args: GetEncryptionScopeArgs, opts?: InvokeOptions): Promise<GetEncryptionScopeResult>
function getEncryptionScopeOutput(args: GetEncryptionScopeOutputArgs, opts?: InvokeOptions): Output<GetEncryptionScopeResult>
Copy
def get_encryption_scope(account_name: Optional[str] = None,
                         encryption_scope_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetEncryptionScopeResult
def get_encryption_scope_output(account_name: Optional[pulumi.Input[str]] = None,
                         encryption_scope_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetEncryptionScopeResult]
Copy
func LookupEncryptionScope(ctx *Context, args *LookupEncryptionScopeArgs, opts ...InvokeOption) (*LookupEncryptionScopeResult, error)
func LookupEncryptionScopeOutput(ctx *Context, args *LookupEncryptionScopeOutputArgs, opts ...InvokeOption) LookupEncryptionScopeResultOutput
Copy

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

public static class GetEncryptionScope 
{
    public static Task<GetEncryptionScopeResult> InvokeAsync(GetEncryptionScopeArgs args, InvokeOptions? opts = null)
    public static Output<GetEncryptionScopeResult> Invoke(GetEncryptionScopeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEncryptionScopeResult> getEncryptionScope(GetEncryptionScopeArgs args, InvokeOptions options)
public static Output<GetEncryptionScopeResult> getEncryptionScope(GetEncryptionScopeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cognitiveservices:getEncryptionScope
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account.
EncryptionScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the encryptionScope associated with the Cognitive Services Account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account.
EncryptionScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the encryptionScope associated with the Cognitive Services Account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of Cognitive Services account.
encryptionScopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the encryptionScope associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account.
encryptionScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the encryptionScope associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of Cognitive Services account.
encryption_scope_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the encryptionScope associated with the Cognitive Services Account
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of Cognitive Services account.
encryptionScopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the encryptionScope associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getEncryptionScope Result

The following output properties are available:

Etag string
Resource Etag.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties Pulumi.AzureNative.CognitiveServices.Outputs.EncryptionScopePropertiesResponse
Properties of Cognitive Services EncryptionScope.
SystemData Pulumi.AzureNative.CognitiveServices.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
Etag string
Resource Etag.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties EncryptionScopePropertiesResponse
Properties of Cognitive Services EncryptionScope.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
etag String
Resource Etag.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties EncryptionScopePropertiesResponse
Properties of Cognitive Services EncryptionScope.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
etag string
Resource Etag.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
properties EncryptionScopePropertiesResponse
Properties of Cognitive Services EncryptionScope.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
etag str
Resource Etag.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
properties EncryptionScopePropertiesResponse
Properties of Cognitive Services EncryptionScope.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
etag String
Resource Etag.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties Property Map
Properties of Cognitive Services EncryptionScope.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

EncryptionScopePropertiesResponse

ProvisioningState This property is required. string
Gets the status of the resource at the time the operation was called.
KeySource string
Enumerates the possible value of keySource for Encryption
KeyVaultProperties Pulumi.AzureNative.CognitiveServices.Inputs.KeyVaultPropertiesResponse
Properties of KeyVault
State string
The encryptionScope state.
ProvisioningState This property is required. string
Gets the status of the resource at the time the operation was called.
KeySource string
Enumerates the possible value of keySource for Encryption
KeyVaultProperties KeyVaultPropertiesResponse
Properties of KeyVault
State string
The encryptionScope state.
provisioningState This property is required. String
Gets the status of the resource at the time the operation was called.
keySource String
Enumerates the possible value of keySource for Encryption
keyVaultProperties KeyVaultPropertiesResponse
Properties of KeyVault
state String
The encryptionScope state.
provisioningState This property is required. string
Gets the status of the resource at the time the operation was called.
keySource string
Enumerates the possible value of keySource for Encryption
keyVaultProperties KeyVaultPropertiesResponse
Properties of KeyVault
state string
The encryptionScope state.
provisioning_state This property is required. str
Gets the status of the resource at the time the operation was called.
key_source str
Enumerates the possible value of keySource for Encryption
key_vault_properties KeyVaultPropertiesResponse
Properties of KeyVault
state str
The encryptionScope state.
provisioningState This property is required. String
Gets the status of the resource at the time the operation was called.
keySource String
Enumerates the possible value of keySource for Encryption
keyVaultProperties Property Map
Properties of KeyVault
state String
The encryptionScope state.

KeyVaultPropertiesResponse

IdentityClientId string
KeyName string
Name of the Key from KeyVault
KeyVaultUri string
Uri of KeyVault
KeyVersion string
Version of the Key from KeyVault
IdentityClientId string
KeyName string
Name of the Key from KeyVault
KeyVaultUri string
Uri of KeyVault
KeyVersion string
Version of the Key from KeyVault
identityClientId String
keyName String
Name of the Key from KeyVault
keyVaultUri String
Uri of KeyVault
keyVersion String
Version of the Key from KeyVault
identityClientId string
keyName string
Name of the Key from KeyVault
keyVaultUri string
Uri of KeyVault
keyVersion string
Version of the Key from KeyVault
identity_client_id str
key_name str
Name of the Key from KeyVault
key_vault_uri str
Uri of KeyVault
key_version str
Version of the Key from KeyVault
identityClientId String
keyName String
Name of the Key from KeyVault
keyVaultUri String
Uri of KeyVault
keyVersion String
Version of the Key from KeyVault

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.

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native