Aspire.Hosting.Azure.Provisioning.KeyVault

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting.Azure.Provisioning.KeyVault

Official

📦 Aspire.Hosting.Azure.Provisioning.KeyVaultv13.6.0-preview.1.26478.8

62Functions

79Types

Search types, functions, members in Aspire.Hosting.Azure.Provisioning.KeyVault...

enumhandlemethodproperty

79 types and 468 members

Clear filtersReset all

Types

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_DictionaryOfStringProxy6 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_DictionaryOfUserAssignedIdentityDetailsProxy6 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfIdentityAccessCertificatePermissionProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfIdentityAccessKeyPermissionProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfIdentityAccessSecretPermissionProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfIdentityAccessStoragePermissionProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfKeyVaultAccessPolicyProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfKeyVaultIPRuleProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfKeyVaultPrivateEndpointConnectionItemDataProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfKeyVaultVirtualNetworkRuleProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfManagedHsmGeoReplicatedRegionProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfManagedHsmIPRuleProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfManagedHsmPrivateEndpointConnectionItemDataProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfManagedHsmVirtualNetworkRuleProxy7 members

handleAspire_Hosting_Azure_Provisioning_KeyVault_Generated_ListOfStringProxy7 members

handleAzureResourceInfrastructureProvisioningExtensions

handleIdentityAccessPermissionsProxy8 members

handleKeyVaultAccessPolicyProxy11 members

handleKeyVaultAzureLocationProxy2 members

handleKeyVaultBuiltInRoleProxy

handleKeyVaultIPRuleProxy3 members

handleKeyVaultManagedServiceIdentityProxy7 members

handleKeyVaultNetworkRuleSetProxy10 members

handleKeyVaultPrivateEndpointConnectionItemDataProxy5 members

handleKeyVaultPrivateEndpointConnectionProxy17 members

handleKeyVaultPrivateLinkServiceConnectionStateProxy9 members

handleKeyVaultPropertiesProxy44 members

handleKeyVaultResourceIdentifierProxy10 members

handleKeyVaultResourceTypeProxy4 members

handleKeyVaultRoleAssignmentProxy34 members

handleKeyVaultSecretProxy13 members

handleKeyVaultServiceProxy14 members

handleKeyVaultSkuProxy6 members

handleKeyVaultSystemDataProxy6 members

handleKeyVaultUserAssignedIdentityDetailsProxy2 members

handleKeyVaultUserAssignedIdentityProxy17 members

handleKeyVaultVirtualNetworkRuleProxy6 members

handleManagedHsmGeoReplicatedRegionProxy7 members

handleManagedHsmIPRuleProxy3 members

handleManagedHsmNetworkRuleSetProxy10 members

handleManagedHsmPrivateEndpointConnectionItemDataProxy5 members

handleManagedHsmPrivateEndpointConnectionProxy24 members

handleManagedHsmPrivateLinkServiceConnectionStateProxy9 members

handleManagedHsmPropertiesProxy30 members

handleManagedHsmProxy17 members

handleManagedHSMSecurityDomainPropertiesProxy2 members

handleManagedHsmSkuProxy6 members

handleManagedHsmVirtualNetworkRuleProxy3 members

handleSecretAttributesProxy11 members

handleSecretPropertiesProxy10 members

Functions

methodaddKeyVaultPrivateEndpointConnection

Adds a KeyVaultPrivateEndpointConnection provisioning model.

addKeyVaultPrivateEndpointConnection(bicepIdentifier: string, resourceVersion?: string): KeyVaultPrivateEndpointConnectionProxy

methodaddKeyVaultRoleAssignment

Adds a RoleAssignment provisioning model.

addKeyVaultRoleAssignment(bicepIdentifier: string, resourceVersion?: string): KeyVaultRoleAssignmentProxy

methodaddKeyVaultSecret

Adds a KeyVaultSecret provisioning model.

addKeyVaultSecret(bicepIdentifier: string, resourceVersion?: string): KeyVaultSecretProxy

methodaddKeyVaultService

Adds a KeyVaultService provisioning model.

addKeyVaultService(bicepIdentifier: string, resourceVersion?: string): KeyVaultServiceProxy

methodaddKeyVaultUserAssignedIdentity

Adds a UserAssignedIdentity provisioning model.

addKeyVaultUserAssignedIdentity(bicepIdentifier: string, resourceVersion?: string): KeyVaultUserAssignedIdentityProxy

methodaddManagedHsm

Adds a ManagedHsm provisioning model.

addManagedHsm(bicepIdentifier: string, resourceVersion?: string): ManagedHsmProxy

methodaddManagedHsmPrivateEndpointConnection

Adds a ManagedHsmPrivateEndpointConnection provisioning model.

addManagedHsmPrivateEndpointConnection(bicepIdentifier: string, resourceVersion?: string): ManagedHsmPrivateEndpointConnectionProxy

methodcreateIdentityAccessPermissions

Creates a IdentityAccessPermissions provisioning model.

createIdentityAccessPermissions(): IdentityAccessPermissionsProxy

methodcreateKeyVaultAccessPolicy

Creates a KeyVaultAccessPolicy provisioning model.

createKeyVaultAccessPolicy(): KeyVaultAccessPolicyProxy

methodcreateKeyVaultAzureLocation

Creates a AzureLocation provisioning model.

createKeyVaultAzureLocation(location: string): KeyVaultAzureLocationProxy

methodcreateKeyVaultBuiltInRole

Creates a KeyVaultBuiltInRole provisioning model.

createKeyVaultBuiltInRole(value: string): KeyVaultBuiltInRoleProxy

methodcreateKeyVaultIPRule

Creates a KeyVaultIPRule provisioning model.

createKeyVaultIPRule(): KeyVaultIPRuleProxy

methodcreateKeyVaultManagedServiceIdentity

Creates a ManagedServiceIdentity provisioning model.

createKeyVaultManagedServiceIdentity(): KeyVaultManagedServiceIdentityProxy

methodcreateKeyVaultNetworkRuleSet

Creates a KeyVaultNetworkRuleSet provisioning model.

createKeyVaultNetworkRuleSet(): KeyVaultNetworkRuleSetProxy

methodcreateKeyVaultPrivateEndpointConnectionItemData

Creates a KeyVaultPrivateEndpointConnectionItemData provisioning model.

createKeyVaultPrivateEndpointConnectionItemData(): KeyVaultPrivateEndpointConnectionItemDataProxy

methodcreateKeyVaultPrivateLinkServiceConnectionState

Creates a KeyVaultPrivateLinkServiceConnectionState provisioning model.

createKeyVaultPrivateLinkServiceConnectionState(): KeyVaultPrivateLinkServiceConnectionStateProxy

methodcreateKeyVaultProperties

Creates a KeyVaultProperties provisioning model.

createKeyVaultProperties(): KeyVaultPropertiesProxy

methodcreateKeyVaultResourceIdentifier

Creates a ResourceIdentifier provisioning model.

createKeyVaultResourceIdentifier(resourceId: string): KeyVaultResourceIdentifierProxy

methodcreateKeyVaultResourceType

Creates a ResourceType provisioning model.

createKeyVaultResourceType(resourceType: string): KeyVaultResourceTypeProxy

methodcreateKeyVaultSku

Creates a KeyVaultSku provisioning model.

createKeyVaultSku(): KeyVaultSkuProxy

methodcreateKeyVaultSystemData

Creates a SystemData provisioning model.

createKeyVaultSystemData(): KeyVaultSystemDataProxy

methodcreateKeyVaultUserAssignedIdentityDetails

Creates a UserAssignedIdentityDetails provisioning model.

createKeyVaultUserAssignedIdentityDetails(): KeyVaultUserAssignedIdentityDetailsProxy

methodcreateKeyVaultVirtualNetworkRule

Creates a KeyVaultVirtualNetworkRule provisioning model.

createKeyVaultVirtualNetworkRule(): KeyVaultVirtualNetworkRuleProxy

methodcreateManagedHsmGeoReplicatedRegion

Creates a ManagedHsmGeoReplicatedRegion provisioning model.

createManagedHsmGeoReplicatedRegion(): ManagedHsmGeoReplicatedRegionProxy

methodcreateManagedHsmIPRule

Creates a ManagedHsmIPRule provisioning model.

createManagedHsmIPRule(): ManagedHsmIPRuleProxy

methodcreateManagedHsmNetworkRuleSet

Creates a ManagedHsmNetworkRuleSet provisioning model.

createManagedHsmNetworkRuleSet(): ManagedHsmNetworkRuleSetProxy

methodcreateManagedHsmPrivateEndpointConnectionItemData

Creates a ManagedHsmPrivateEndpointConnectionItemData provisioning model.

createManagedHsmPrivateEndpointConnectionItemData(): ManagedHsmPrivateEndpointConnectionItemDataProxy

methodcreateManagedHsmPrivateLinkServiceConnectionState

Creates a ManagedHsmPrivateLinkServiceConnectionState provisioning model.

createManagedHsmPrivateLinkServiceConnectionState(): ManagedHsmPrivateLinkServiceConnectionStateProxy

methodcreateManagedHsmProperties

Creates a ManagedHsmProperties provisioning model.

createManagedHsmProperties(): ManagedHsmPropertiesProxy

methodcreateManagedHSMSecurityDomainProperties

Creates a ManagedHSMSecurityDomainProperties provisioning model.

createManagedHSMSecurityDomainProperties(): ManagedHSMSecurityDomainPropertiesProxy

methodcreateManagedHsmSku

Creates a ManagedHsmSku provisioning model.

createManagedHsmSku(): ManagedHsmSkuProxy

methodcreateManagedHsmVirtualNetworkRule

Creates a ManagedHsmVirtualNetworkRule provisioning model.

createManagedHsmVirtualNetworkRule(): ManagedHsmVirtualNetworkRuleProxy

methodcreateSecretAttributes

Creates a SecretAttributes provisioning model.

createSecretAttributes(): SecretAttributesProxy

methodcreateSecretProperties

Creates a SecretProperties provisioning model.

createSecretProperties(): SecretPropertiesProxy

methodgetKeyVaultBuiltInRoleKeyVaultAdministrator

Gets the KeyVaultAdministrator value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultAdministrator(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultCertificatesOfficer

Gets the KeyVaultCertificatesOfficer value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultCertificatesOfficer(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultCertificateUser

Gets the KeyVaultCertificateUser value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultCertificateUser(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultContributor

Gets the KeyVaultContributor value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultContributor(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultCryptoOfficer

Gets the KeyVaultCryptoOfficer value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultCryptoOfficer(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultCryptoServiceEncryptionUser

Gets the KeyVaultCryptoServiceEncryptionUser value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultCryptoServiceEncryptionUser(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultCryptoServiceReleaseUser

Gets the KeyVaultCryptoServiceReleaseUser value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultCryptoServiceReleaseUser(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultCryptoUser

Gets the KeyVaultCryptoUser value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultCryptoUser(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultDataAccessAdministrator

Gets the KeyVaultDataAccessAdministrator value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultDataAccessAdministrator(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultReader

Gets the KeyVaultReader value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultReader(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultSecretsOfficer

Gets the KeyVaultSecretsOfficer value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultSecretsOfficer(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleKeyVaultSecretsUser

Gets the KeyVaultSecretsUser value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleKeyVaultSecretsUser(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultBuiltInRoleManagedHsmContributor

Gets the ManagedHsmContributor value defined by KeyVaultBuiltInRole.

getKeyVaultBuiltInRoleManagedHsmContributor(): KeyVaultBuiltInRoleProxy

methodgetKeyVaultPrivateEndpointConnectionByIdentifier

Gets a KeyVaultPrivateEndpointConnection provisioning resource by its Bicep identifier.

getKeyVaultPrivateEndpointConnectionByIdentifier(bicepIdentifier: string): KeyVaultPrivateEndpointConnectionProxy

methodgetKeyVaultPrivateEndpointConnections

Gets all KeyVaultPrivateEndpointConnection provisioning resources.

getKeyVaultPrivateEndpointConnections(): KeyVaultPrivateEndpointConnectionProxy[]

methodgetKeyVaultRoleAssignmentByIdentifier

Gets a RoleAssignment provisioning resource by its Bicep identifier.

getKeyVaultRoleAssignmentByIdentifier(bicepIdentifier: string): KeyVaultRoleAssignmentProxy

methodgetKeyVaultRoleAssignments

Gets all RoleAssignment provisioning resources.

getKeyVaultRoleAssignments(): KeyVaultRoleAssignmentProxy[]

methodgetKeyVaultSecretByIdentifier

Gets a KeyVaultSecret provisioning resource by its Bicep identifier.

getKeyVaultSecretByIdentifier(bicepIdentifier: string): KeyVaultSecretProxy

methodgetKeyVaultSecrets

Gets all KeyVaultSecret provisioning resources.

getKeyVaultSecrets(): KeyVaultSecretProxy[]

methodgetKeyVaultService

Gets the KeyVaultService provisioning resource for the current Aspire resource.

getKeyVaultService(): KeyVaultServiceProxy

methodgetKeyVaultServiceByIdentifier

Gets a KeyVaultService provisioning resource by its Bicep identifier.

getKeyVaultServiceByIdentifier(bicepIdentifier: string): KeyVaultServiceProxy

methodgetKeyVaultServices

Gets all KeyVaultService provisioning resources.

getKeyVaultServices(): KeyVaultServiceProxy[]

methodgetKeyVaultUserAssignedIdentities

Gets all UserAssignedIdentity provisioning resources.

getKeyVaultUserAssignedIdentities(): KeyVaultUserAssignedIdentityProxy[]

methodgetKeyVaultUserAssignedIdentityByIdentifier

Gets a UserAssignedIdentity provisioning resource by its Bicep identifier.

getKeyVaultUserAssignedIdentityByIdentifier(bicepIdentifier: string): KeyVaultUserAssignedIdentityProxy

methodgetManagedHsmByIdentifier

Gets a ManagedHsm provisioning resource by its Bicep identifier.

getManagedHsmByIdentifier(bicepIdentifier: string): ManagedHsmProxy

methodgetManagedHsmPrivateEndpointConnectionByIdentifier

Gets a ManagedHsmPrivateEndpointConnection provisioning resource by its Bicep identifier.

getManagedHsmPrivateEndpointConnectionByIdentifier(bicepIdentifier: string): ManagedHsmPrivateEndpointConnectionProxy

methodgetManagedHsmPrivateEndpointConnections

Gets all ManagedHsmPrivateEndpointConnection provisioning resources.

getManagedHsmPrivateEndpointConnections(): ManagedHsmPrivateEndpointConnectionProxy[]

methodgetManagedHsms

Gets all ManagedHsm provisioning resources.

getManagedHsms(): ManagedHsmProxy[]

Enums

enumCreatedByType4 values

enumIdentityAccessCertificatePermission17 values

enumIdentityAccessKeyPermission21 values

enumIdentityAccessSecretPermission9 values

enumIdentityAccessStoragePermission15 values

enumIsolationScope2 values

enumKeyVaultActionsRequiredMessage1 values

enumKeyVaultCreateMode2 values

enumKeyVaultNetworkRuleAction2 values

enumKeyVaultNetworkRuleBypassOption2 values

enumKeyVaultPrivateEndpointConnectionProvisioningState6 values

enumKeyVaultPrivateEndpointServiceConnectionStatus4 values

enumKeyVaultProvisioningState2 values

enumKeyVaultSkuFamily1 values

enumKeyVaultSkuName2 values

enumManagedHsmActionsRequiredMessage1 values

enumManagedHsmCreateMode2 values

enumManagedHsmGeoReplicatedRegionProvisioningState6 values

enumManagedHsmNetworkRuleAction2 values

enumManagedHsmNetworkRuleBypassOption2 values

enumManagedHsmPrivateEndpointConnectionProvisioningState6 values

enumManagedHsmPrivateEndpointServiceConnectionStatus4 values

enumManagedHsmProvisioningState8 values

enumManagedHsmPublicNetworkAccess2 values

enumManagedHSMSecurityDomainActivationStatus4 values

enumManagedHsmSkuFamily2 values

enumManagedHsmSkuName5 values

enumManagedServiceIdentityType4 values

enumRoleManagementPrincipalType5 values