azure-native.cognitiveservices.getEncryptionScope
Explore with Pulumi AI
Gets the specified EncryptionScope associated with the Cognitive Services account.
Uses Azure REST API version 2024-10-01.
Other available API versions: 2023-10-01-preview, 2024-04-01-preview, 2024-06-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cognitiveservices [ApiVersion]. See the version guide for details.
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>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]func LookupEncryptionScope(ctx *Context, args *LookupEncryptionScopeArgs, opts ...InvokeOption) (*LookupEncryptionScopeResult, error)
func LookupEncryptionScopeOutput(ctx *Context, args *LookupEncryptionScopeOutputArgs, opts ...InvokeOption) LookupEncryptionScopeResultOutput> 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)
}public static CompletableFuture<GetEncryptionScopeResult> getEncryptionScope(GetEncryptionScopeArgs args, InvokeOptions options)
public static Output<GetEncryptionScopeResult> getEncryptionScope(GetEncryptionScopeArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:cognitiveservices:getEncryptionScope
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Account
Name string - The name of Cognitive Services account.
 - Encryption
Scope stringName  - The name of the encryptionScope associated with the Cognitive Services Account
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Account
Name string - The name of Cognitive Services account.
 - Encryption
Scope stringName  - The name of the encryptionScope associated with the Cognitive Services Account
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- account
Name String - The name of Cognitive Services account.
 - encryption
Scope StringName  - The name of the encryptionScope associated with the Cognitive Services Account
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- account
Name string - The name of Cognitive Services account.
 - encryption
Scope stringName  - The name of the encryptionScope associated with the Cognitive Services Account
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- account_
name str - The name of Cognitive Services account.
 - encryption_
scope_ strname  - The name of the encryptionScope associated with the Cognitive Services Account
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 
- account
Name String - The name of Cognitive Services account.
 - encryption
Scope StringName  - The name of the encryptionScope associated with the Cognitive Services Account
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
getEncryptionScope Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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.
Azure Native. Cognitive Services. Outputs. Encryption Scope Properties Response  - Properties of Cognitive Services EncryptionScope.
 - System
Data Pulumi.Azure Native. Cognitive Services. Outputs. System Data Response  - 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"
 - Dictionary<string, string>
 - Resource tags.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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
Encryption
Scope Properties Response  - Properties of Cognitive Services EncryptionScope.
 - System
Data SystemData Response  - 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"
 - map[string]string
 - Resource tags.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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
Encryption
Scope Properties Response  - Properties of Cognitive Services EncryptionScope.
 - system
Data SystemData Response  - 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"
 - Map<String,String>
 - Resource tags.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - 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
Encryption
Scope Properties Response  - Properties of Cognitive Services EncryptionScope.
 - system
Data SystemData Response  - 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"
 - {[key: string]: string}
 - Resource tags.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - 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
Encryption
Scope Properties Response  - Properties of Cognitive Services EncryptionScope.
 - system_
data SystemData Response  - 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"
 - Mapping[str, str]
 - Resource tags.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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.
 - system
Data 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"
 - Map<String>
 - Resource tags.
 
Supporting Types
EncryptionScopePropertiesResponse   
- Provisioning
State string - Gets the status of the resource at the time the operation was called.
 - Key
Source string - Enumerates the possible value of keySource for Encryption
 - Key
Vault Pulumi.Properties Azure Native. Cognitive Services. Inputs. Key Vault Properties Response  - Properties of KeyVault
 - State string
 - The encryptionScope state.
 
- Provisioning
State string - Gets the status of the resource at the time the operation was called.
 - Key
Source string - Enumerates the possible value of keySource for Encryption
 - Key
Vault KeyProperties Vault Properties Response  - Properties of KeyVault
 - State string
 - The encryptionScope state.
 
- provisioning
State String - Gets the status of the resource at the time the operation was called.
 - key
Source String - Enumerates the possible value of keySource for Encryption
 - key
Vault KeyProperties Vault Properties Response  - Properties of KeyVault
 - state String
 - The encryptionScope state.
 
- provisioning
State string - Gets the status of the resource at the time the operation was called.
 - key
Source string - Enumerates the possible value of keySource for Encryption
 - key
Vault KeyProperties Vault Properties Response  - Properties of KeyVault
 - state string
 - The encryptionScope state.
 
- provisioning_
state 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_ Keyproperties Vault Properties Response  - Properties of KeyVault
 - state str
 - The encryptionScope state.
 
- provisioning
State String - Gets the status of the resource at the time the operation was called.
 - key
Source String - Enumerates the possible value of keySource for Encryption
 - key
Vault Property MapProperties  - Properties of KeyVault
 - state String
 - The encryptionScope state.
 
KeyVaultPropertiesResponse   
- Identity
Client stringId  - Key
Name string - Name of the Key from KeyVault
 - Key
Vault stringUri  - Uri of KeyVault
 - Key
Version string - Version of the Key from KeyVault
 
- Identity
Client stringId  - Key
Name string - Name of the Key from KeyVault
 - Key
Vault stringUri  - Uri of KeyVault
 - Key
Version string - Version of the Key from KeyVault
 
- identity
Client StringId  - key
Name String - Name of the Key from KeyVault
 - key
Vault StringUri  - Uri of KeyVault
 - key
Version String - Version of the Key from KeyVault
 
- identity
Client stringId  - key
Name string - Name of the Key from KeyVault
 - key
Vault stringUri  - Uri of KeyVault
 - key
Version string - Version of the Key from KeyVault
 
- identity_
client_ strid  - key_
name str - Name of the Key from KeyVault
 - key_
vault_ struri  - Uri of KeyVault
 - key_
version str - Version of the Key from KeyVault
 
- identity
Client StringId  - key
Name String - Name of the Key from KeyVault
 - key
Vault StringUri  - Uri of KeyVault
 - key
Version String - Version of the Key from KeyVault
 
SystemDataResponse  
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
- created
At string - The timestamp of resource creation (UTC).
 - created
By string - The identity that created the resource.
 - created
By stringType  - The type of identity that created the resource.
 - last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - last
Modified stringBy  - The identity that last modified the resource.
 - last
Modified stringBy Type  - 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_ strtype  - The type of identity that created the resource.
 - last_
modified_ strat  - The timestamp of resource last modification (UTC)
 - last_
modified_ strby  - The identity that last modified the resource.
 - last_
modified_ strby_ type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0