CosmosDBAccountProxy

Handle

📦 Aspire.Hosting.Azure.Provisioning.CosmosDB v13.6.0-preview.1.26478.8

interface CosmosDBAccountProxy {
  analyticalStorageSchemaType: BicepValueProxy | AnalyticalStorageSchemaType;
  apiServerVersion: BicepValueProxy | CosmosDBServerVersion;
  backupPolicy: CosmosDBAccountBackupPolicyProxy;
  capabilities: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountCapabilityProxy;
  capacityTotalThroughputLimit: BicepValueProxy | number;
  connectorOffer: BicepValueProxy | ConnectorOffer;
  consistencyPolicy: ConsistencyPolicyProxy;
  cors: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountCorsPolicyProxy;
  createMode: BicepValueProxy | CosmosDBAccountCreateMode;
  customerManagedKeyStatus: BicepValueProxy | string;
  databaseAccountOfferType: BicepValueProxy | CosmosDBAccountOfferType;
  defaultIdentity: BicepValueProxy | string;
  defaultPriorityLevel: BicepValueProxy | DefaultPriorityLevel;
  diagnosticLogEnableFullTextQuery: BicepValueProxy | EnableFullTextQuery;
  disableKeyBasedMetadataWriteAccess: BicepValueProxy | boolean;
  disableLocalAuth: BicepValueProxy | boolean;
  readonly documentEndpoint: BicepValueProxy | string;
  enableAutomaticFailover: BicepValueProxy | boolean;
  enableBurstCapacity: BicepValueProxy | boolean;
  enableCassandraConnector: BicepValueProxy | boolean;
  enableMaterializedViews: BicepValueProxy | boolean;
  enableMultipleWriteLocations: BicepValueProxy | boolean;
  enablePartitionMerge: BicepValueProxy | boolean;
  enablePerRegionPerPartitionAutoscale: BicepValueProxy | boolean;
  enablePriorityBasedExecution: BicepValueProxy | boolean;
  readonly failoverPolicies: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBFailoverPolicyProxy;
  readonly id: BicepValueProxy;
  identity: CosmosDBManagedServiceIdentityProxy;
  readonly instanceId: BicepValueProxy | guid;
  iPRules: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBIPAddressOrRangeProxy;
  isAnalyticalStorageEnabled: BicepValueProxy | boolean;
  isFreeTierEnabled: BicepValueProxy | boolean;
  isVirtualNetworkFilterEnabled: BicepValueProxy | boolean;
  readonly keysMetadata: DatabaseAccountKeysMetadataProxy;
  keyVaultKeyUri: BicepValueProxy | uri;
  kind: BicepValueProxy | CosmosDBAccountKind;
  location: BicepValueProxy;
  locations: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountLocationProxy;
  minimalTlsVersion: BicepValueProxy | CosmosDBMinimalTlsVersion;
  name: BicepValueProxy | string;
  networkAclBypass: BicepValueProxy | NetworkAclBypass;
  networkAclBypassResourceIds: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfResourceIdentifierProxy;
  readonly privateEndpointConnections: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBPrivateEndpointConnectionDataProxy;
  readonly provisioningState: BicepValueProxy | string;
  publicNetworkAccess: BicepValueProxy | CosmosDBPublicNetworkAccess;
  readonly readLocations: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountLocationProxy;
  restoreParameters: CosmosDBAccountRestoreParametersProxy;
  readonly systemData: CosmosDBSystemDataProxy;
  tags: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_DictionaryOfStringProxy;
  virtualNetworkRules: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBVirtualNetworkRuleProxy;
  readonly writeLocations: Aspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountLocationProxy;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearAnalyticalStorageSchemaType(): void;
  clearApiServerVersion(): void;
  clearCapacityTotalThroughputLimit(): void;
  clearConnectorOffer(): void;
  clearCreateMode(): void;
  clearCustomerManagedKeyStatus(): void;
  clearDatabaseAccountOfferType(): void;
  clearDefaultIdentity(): void;
  clearDefaultPriorityLevel(): void;
  clearDiagnosticLogEnableFullTextQuery(): void;
  clearDisableKeyBasedMetadataWriteAccess(): void;
  clearDisableLocalAuth(): void;
  clearEnableAutomaticFailover(): void;
  clearEnableBurstCapacity(): void;
  clearEnableCassandraConnector(): void;
  clearEnableMaterializedViews(): void;
  clearEnableMultipleWriteLocations(): void;
  clearEnablePartitionMerge(): void;
  clearEnablePerRegionPerPartitionAutoscale(): void;
  clearEnablePriorityBasedExecution(): void;
  clearIsAnalyticalStorageEnabled(): void;
  clearIsFreeTierEnabled(): void;
  clearIsVirtualNetworkFilterEnabled(): void;
  clearKeyVaultKeyUri(): void;
  clearKind(): void;
  clearLocation(): void;
  clearMinimalTlsVersion(): void;
  clearName(): void;
  clearNetworkAclBypass(): void;
  clearPublicNetworkAccess(): void;
  createRoleAssignment(
      role: CosmosDBBuiltInRoleProxy,
      principalType: BicepValueProxy | RoleManagementPrincipalType,
      principalId: BicepValueProxy | guid,
      bicepIdentifierSuffix: string): CosmosDBRoleAssignmentProxy;
  getKeys(): CosmosDBAccountKeyListProxy;
}

125 members

Properties

propertyanalyticalStorageSchemaTypeBicepValueProxy | AnalyticalStorageSchemaTypeget · set

Gets or sets the AnalyticalStorageSchemaType provisioning property.

propertyapiServerVersionBicepValueProxy | CosmosDBServerVersionget · set

Gets or sets the ApiServerVersion provisioning property.

propertybackupPolicyCosmosDBAccountBackupPolicyProxyget · set

Gets or sets the BackupPolicy provisioning property.

propertycapabilitiesAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountCapabilityProxyget · set

Gets or sets the Capabilities provisioning property.

propertycapacityTotalThroughputLimitBicepValueProxy | numberget · set

Gets or sets the CapacityTotalThroughputLimit provisioning property.

propertyconnectorOfferBicepValueProxy | ConnectorOfferget · set

Gets or sets the ConnectorOffer provisioning property.

propertyconsistencyPolicyConsistencyPolicyProxyget · set

Gets or sets the ConsistencyPolicy provisioning property.

propertycorsAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountCorsPolicyProxyget · set

Gets or sets the Cors provisioning property.

propertycreateModeBicepValueProxy | CosmosDBAccountCreateModeget · set

Gets or sets the CreateMode provisioning property.

propertycustomerManagedKeyStatusBicepValueProxy | stringget · set

Gets or sets the CustomerManagedKeyStatus provisioning property.

propertydatabaseAccountOfferTypeBicepValueProxy | CosmosDBAccountOfferTypeget · set

Gets or sets the DatabaseAccountOfferType provisioning property.

propertydefaultIdentityBicepValueProxy | stringget · set

Gets or sets the DefaultIdentity provisioning property.

propertydefaultPriorityLevelBicepValueProxy | DefaultPriorityLevelget · set

Gets or sets the DefaultPriorityLevel provisioning property.

propertydiagnosticLogEnableFullTextQueryBicepValueProxy | EnableFullTextQueryget · set

Gets or sets the DiagnosticLogEnableFullTextQuery provisioning property.

propertydisableKeyBasedMetadataWriteAccessBicepValueProxy | booleanget · set

Gets or sets the DisableKeyBasedMetadataWriteAccess provisioning property.

propertydisableLocalAuthBicepValueProxy | booleanget · set

Gets or sets the DisableLocalAuth provisioning property.

propertydocumentEndpointBicepValueProxy | stringget

Gets the DocumentEndpoint provisioning property.

propertyenableAutomaticFailoverBicepValueProxy | booleanget · set

Gets or sets the EnableAutomaticFailover provisioning property.

propertyenableBurstCapacityBicepValueProxy | booleanget · set

Gets or sets the EnableBurstCapacity provisioning property.

propertyenableCassandraConnectorBicepValueProxy | booleanget · set

Gets or sets the EnableCassandraConnector provisioning property.

propertyenableMaterializedViewsBicepValueProxy | booleanget · set

Gets or sets the EnableMaterializedViews provisioning property.

propertyenableMultipleWriteLocationsBicepValueProxy | booleanget · set

Gets or sets the EnableMultipleWriteLocations provisioning property.

propertyenablePartitionMergeBicepValueProxy | booleanget · set

Gets or sets the EnablePartitionMerge provisioning property.

propertyenablePerRegionPerPartitionAutoscaleBicepValueProxy | booleanget · set

Gets or sets the EnablePerRegionPerPartitionAutoscale provisioning property.

propertyenablePriorityBasedExecutionBicepValueProxy | booleanget · set

Gets or sets the EnablePriorityBasedExecution provisioning property.

propertyfailoverPoliciesAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBFailoverPolicyProxyget

Gets the FailoverPolicies provisioning property.

propertyidBicepValueProxyget

Gets the Id provisioning property.

propertyidentityCosmosDBManagedServiceIdentityProxyget · set

Gets or sets the Identity provisioning property.

propertyinstanceIdBicepValueProxy | guidget

Gets the InstanceId provisioning property.

propertyiPRulesAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBIPAddressOrRangeProxyget · set

Gets or sets the IPRules provisioning property.

propertyisAnalyticalStorageEnabledBicepValueProxy | booleanget · set

Gets or sets the IsAnalyticalStorageEnabled provisioning property.

propertyisFreeTierEnabledBicepValueProxy | booleanget · set

Gets or sets the IsFreeTierEnabled provisioning property.

propertyisVirtualNetworkFilterEnabledBicepValueProxy | booleanget · set

Gets or sets the IsVirtualNetworkFilterEnabled provisioning property.

propertykeysMetadataDatabaseAccountKeysMetadataProxyget

Gets the KeysMetadata provisioning property.

propertykeyVaultKeyUriBicepValueProxy | uriget · set

Gets or sets the KeyVaultKeyUri provisioning property.

propertykindBicepValueProxy | CosmosDBAccountKindget · set

Gets or sets the Kind provisioning property.

propertylocationBicepValueProxyget · set

Gets or sets the Location provisioning property.

propertylocationsAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountLocationProxyget · set

Gets or sets the Locations provisioning property.

propertyminimalTlsVersionBicepValueProxy | CosmosDBMinimalTlsVersionget · set

Gets or sets the MinimalTlsVersion provisioning property.

propertynameBicepValueProxy | stringget · set

Gets or sets the Name provisioning property.

propertynetworkAclBypassBicepValueProxy | NetworkAclBypassget · set

Gets or sets the NetworkAclBypass provisioning property.

propertynetworkAclBypassResourceIdsAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfResourceIdentifierProxyget · set

Gets or sets the NetworkAclBypassResourceIds provisioning property.

propertyprivateEndpointConnectionsAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBPrivateEndpointConnectionDataProxyget

Gets the PrivateEndpointConnections provisioning property.

propertyprovisioningStateBicepValueProxy | stringget

Gets the ProvisioningState provisioning property.

propertypublicNetworkAccessBicepValueProxy | CosmosDBPublicNetworkAccessget · set

Gets or sets the PublicNetworkAccess provisioning property.

propertyreadLocationsAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountLocationProxyget

Gets the ReadLocations provisioning property.

propertyrestoreParametersCosmosDBAccountRestoreParametersProxyget · set

Gets or sets the RestoreParameters provisioning property.

propertysystemDataCosmosDBSystemDataProxyget

Gets the SystemData provisioning property.

propertytagsAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_DictionaryOfStringProxyget · set

Gets or sets the Tags provisioning property.

propertyvirtualNetworkRulesAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBVirtualNetworkRuleProxyget · set

Gets or sets the VirtualNetworkRules provisioning property.

propertywriteLocationsAspire_Hosting_Azure_Provisioning_CosmosDB_Generated_ListOfCosmosDBAccountLocationProxyget

Gets the WriteLocations provisioning property.

Methods

methodaddTo

Adds this provisioning resource to the Azure resource infrastructure.

addTo(infrastructure: AzureResourceInfrastructure): void

Parameters

infrastructureAzureResourceInfrastructure

methodclearAnalyticalStorageSchemaType

Clears the AnalyticalStorageSchemaType provisioning property.

clearAnalyticalStorageSchemaType(): void

methodclearApiServerVersion

Clears the ApiServerVersion provisioning property.

clearApiServerVersion(): void

methodclearCapacityTotalThroughputLimit

Clears the CapacityTotalThroughputLimit provisioning property.

clearCapacityTotalThroughputLimit(): void

methodclearConnectorOffer

Clears the ConnectorOffer provisioning property.

clearConnectorOffer(): void

methodclearCreateMode

Clears the CreateMode provisioning property.

clearCreateMode(): void

methodclearCustomerManagedKeyStatus

Clears the CustomerManagedKeyStatus provisioning property.

clearCustomerManagedKeyStatus(): void

methodclearDatabaseAccountOfferType

Clears the DatabaseAccountOfferType provisioning property.

clearDatabaseAccountOfferType(): void

methodclearDefaultIdentity

Clears the DefaultIdentity provisioning property.

clearDefaultIdentity(): void

methodclearDefaultPriorityLevel

Clears the DefaultPriorityLevel provisioning property.

clearDefaultPriorityLevel(): void

methodclearDiagnosticLogEnableFullTextQuery

Clears the DiagnosticLogEnableFullTextQuery provisioning property.

clearDiagnosticLogEnableFullTextQuery(): void

methodclearDisableKeyBasedMetadataWriteAccess

Clears the DisableKeyBasedMetadataWriteAccess provisioning property.

clearDisableKeyBasedMetadataWriteAccess(): void

methodclearDisableLocalAuth

Clears the DisableLocalAuth provisioning property.

clearDisableLocalAuth(): void

methodclearEnableAutomaticFailover

Clears the EnableAutomaticFailover provisioning property.

clearEnableAutomaticFailover(): void

methodclearEnableBurstCapacity

Clears the EnableBurstCapacity provisioning property.

clearEnableBurstCapacity(): void

methodclearEnableCassandraConnector

Clears the EnableCassandraConnector provisioning property.

clearEnableCassandraConnector(): void

methodclearEnableMaterializedViews

Clears the EnableMaterializedViews provisioning property.

clearEnableMaterializedViews(): void

methodclearEnableMultipleWriteLocations

Clears the EnableMultipleWriteLocations provisioning property.

clearEnableMultipleWriteLocations(): void

methodclearEnablePartitionMerge

Clears the EnablePartitionMerge provisioning property.

clearEnablePartitionMerge(): void

methodclearEnablePerRegionPerPartitionAutoscale

Clears the EnablePerRegionPerPartitionAutoscale provisioning property.

clearEnablePerRegionPerPartitionAutoscale(): void

methodclearEnablePriorityBasedExecution

Clears the EnablePriorityBasedExecution provisioning property.

clearEnablePriorityBasedExecution(): void

methodclearIsAnalyticalStorageEnabled

Clears the IsAnalyticalStorageEnabled provisioning property.

clearIsAnalyticalStorageEnabled(): void

methodclearIsFreeTierEnabled

Clears the IsFreeTierEnabled provisioning property.

clearIsFreeTierEnabled(): void

methodclearIsVirtualNetworkFilterEnabled

Clears the IsVirtualNetworkFilterEnabled provisioning property.

clearIsVirtualNetworkFilterEnabled(): void

methodclearKeyVaultKeyUri

Clears the KeyVaultKeyUri provisioning property.

clearKeyVaultKeyUri(): void

methodclearKind

Clears the Kind provisioning property.

clearKind(): void

methodclearLocation

Clears the Location provisioning property.

clearLocation(): void

methodclearMinimalTlsVersion

Clears the MinimalTlsVersion provisioning property.

clearMinimalTlsVersion(): void

methodclearName

Clears the Name provisioning property.

clearName(): void

methodclearNetworkAclBypass

Clears the NetworkAclBypass provisioning property.

clearNetworkAclBypass(): void

methodclearPublicNetworkAccess

Clears the PublicNetworkAccess provisioning property.

clearPublicNetworkAccess(): void

methodcreateRoleAssignment

Invokes CreateRoleAssignment on the CosmosDBAccount provisioning model.

createRoleAssignment(
    role: CosmosDBBuiltInRoleProxy,
    principalType: BicepValueProxy | RoleManagementPrincipalType,
    principalId: BicepValueProxy | guid,
    bicepIdentifierSuffix: string): CosmosDBRoleAssignmentProxy

Parameters

roleCosmosDBBuiltInRoleProxy

principalTypeBicepValueProxy | RoleManagementPrincipalType

principalIdBicepValueProxy | guid

bicepIdentifierSuffixstring

Returns

CosmosDBRoleAssignmentProxy

methodgetKeys

Invokes GetKeys on the CosmosDBAccount provisioning model.

getKeys(): CosmosDBAccountKeyListProxy

Returns

CosmosDBAccountKeyListProxy