417 строки
32 KiB
YAML
417 строки
32 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount"
|
|
name: "CosmosDBAccount"
|
|
nameWithType: "CosmosDBAccount"
|
|
summary: "An immutable client-side representation of an Azure Cosmos DB."
|
|
syntax: "public interface **CosmosDBAccount**</br> extends <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager?alt=com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager&text=CosmosDBManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountGetResultsInner?alt=com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountGetResultsInner&text=DatabaseAccountGetResultsInner\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.CosmosDBAccount?alt=com.microsoft.azure.management.cosmosdb.CosmosDBAccount&text=CosmosDBAccount\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.CosmosDBAccount.Update?alt=com.microsoft.azure.management.cosmosdb.CosmosDBAccount.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.capabilities()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.capabilities()"
|
|
name: "capabilities()"
|
|
nameWithType: "CosmosDBAccount.capabilities()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract List<Capability> capabilities()"
|
|
returns:
|
|
description: "a list that contains the Cosmos DB capabilities"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.Capability?alt=com.microsoft.azure.management.cosmosdb.Capability&text=Capability\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.cassandraConnectorEnabled()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.cassandraConnectorEnabled()"
|
|
name: "cassandraConnectorEnabled()"
|
|
nameWithType: "CosmosDBAccount.cassandraConnectorEnabled()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract boolean cassandraConnectorEnabled()"
|
|
returns:
|
|
description: "whether cassandra connector is enabled or not."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.cassandraConnectorOffer()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.cassandraConnectorOffer()"
|
|
name: "cassandraConnectorOffer()"
|
|
nameWithType: "CosmosDBAccount.cassandraConnectorOffer()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract ConnectorOffer cassandraConnectorOffer()"
|
|
returns:
|
|
description: "the current cassandra connector offer."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.ConnectorOffer?alt=com.microsoft.azure.management.cosmosdb.ConnectorOffer&text=ConnectorOffer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.consistencyPolicy()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.consistencyPolicy()"
|
|
name: "consistencyPolicy()"
|
|
nameWithType: "CosmosDBAccount.consistencyPolicy()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract ConsistencyPolicy consistencyPolicy()"
|
|
returns:
|
|
description: "the consistency policy for the CosmosDB database account"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.ConsistencyPolicy?alt=com.microsoft.azure.management.cosmosdb.ConsistencyPolicy&text=ConsistencyPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.databaseAccountOfferType()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.databaseAccountOfferType()"
|
|
name: "databaseAccountOfferType()"
|
|
nameWithType: "CosmosDBAccount.databaseAccountOfferType()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract DatabaseAccountOfferType databaseAccountOfferType()"
|
|
returns:
|
|
description: "the offer type for the CosmosDB database account"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountOfferType?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountOfferType&text=DatabaseAccountOfferType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.defaultConsistencyLevel()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.defaultConsistencyLevel()"
|
|
name: "defaultConsistencyLevel()"
|
|
nameWithType: "CosmosDBAccount.defaultConsistencyLevel()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract DefaultConsistencyLevel defaultConsistencyLevel()"
|
|
returns:
|
|
description: "the default consistency level for the CosmosDB database account"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DefaultConsistencyLevel?alt=com.microsoft.azure.management.cosmosdb.DefaultConsistencyLevel&text=DefaultConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.documentEndpoint()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.documentEndpoint()"
|
|
name: "documentEndpoint()"
|
|
nameWithType: "CosmosDBAccount.documentEndpoint()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String documentEndpoint()"
|
|
returns:
|
|
description: "the connection endpoint for the CosmosDB database account"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateEndpointConnection(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateEndpointConnection(String name)"
|
|
name: "getPrivateEndpointConnection(String name)"
|
|
nameWithType: "CosmosDBAccount.getPrivateEndpointConnection(String name)"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "name of private endpoint connection"
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract PrivateEndpointConnection getPrivateEndpointConnection(String name)"
|
|
returns:
|
|
description: "the specific private endpoint connection"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection?alt=com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection&text=PrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateEndpointConnectionAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateEndpointConnectionAsync(String name)"
|
|
name: "getPrivateEndpointConnectionAsync(String name)"
|
|
nameWithType: "CosmosDBAccount.getPrivateEndpointConnectionAsync(String name)"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "name of private endpoint connection"
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<PrivateEndpointConnection> getPrivateEndpointConnectionAsync(String name)"
|
|
returns:
|
|
description: "the specific private endpoint connection"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection?alt=com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection&text=PrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateLinkResource(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateLinkResource(String groupName)"
|
|
name: "getPrivateLinkResource(String groupName)"
|
|
nameWithType: "CosmosDBAccount.getPrivateLinkResource(String groupName)"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "group name of private link resource"
|
|
name: "groupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract PrivateLinkResource getPrivateLinkResource(String groupName)"
|
|
returns:
|
|
description: "the specific private link resource group"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateLinkResource?alt=com.microsoft.azure.management.cosmosdb.PrivateLinkResource&text=PrivateLinkResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateLinkResourceAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.getPrivateLinkResourceAsync(String groupName)"
|
|
name: "getPrivateLinkResourceAsync(String groupName)"
|
|
nameWithType: "CosmosDBAccount.getPrivateLinkResourceAsync(String groupName)"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "group name of private link resource"
|
|
name: "groupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<PrivateLinkResource> getPrivateLinkResourceAsync(String groupName)"
|
|
returns:
|
|
description: "the specific private link resource group"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateLinkResource?alt=com.microsoft.azure.management.cosmosdb.PrivateLinkResource&text=PrivateLinkResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.ipRangeFilter()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.ipRangeFilter()"
|
|
name: "ipRangeFilter()"
|
|
nameWithType: "CosmosDBAccount.ipRangeFilter()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String ipRangeFilter()"
|
|
returns:
|
|
description: "specifies the set of IP addresses or IP address ranges in CIDR form."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.keyBasedMetadataWriteAccessDisabled()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.keyBasedMetadataWriteAccessDisabled()"
|
|
name: "keyBasedMetadataWriteAccessDisabled()"
|
|
nameWithType: "CosmosDBAccount.keyBasedMetadataWriteAccessDisabled()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract boolean keyBasedMetadataWriteAccessDisabled()"
|
|
returns:
|
|
description: "whether metadata write access is disabled or not."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.kind()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.kind()"
|
|
name: "kind()"
|
|
nameWithType: "CosmosDBAccount.kind()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract DatabaseAccountKind kind()"
|
|
returns:
|
|
description: "indicates the type of database account"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountKind?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountKind&text=DatabaseAccountKind\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listConnectionStrings()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listConnectionStrings()"
|
|
name: "listConnectionStrings()"
|
|
nameWithType: "CosmosDBAccount.listConnectionStrings()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract DatabaseAccountListConnectionStringsResult listConnectionStrings()"
|
|
returns:
|
|
description: "the connection strings for the specified Azure CosmosDB database account"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountListConnectionStringsResult?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountListConnectionStringsResult&text=DatabaseAccountListConnectionStringsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listConnectionStringsAsync()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listConnectionStringsAsync()"
|
|
name: "listConnectionStringsAsync()"
|
|
nameWithType: "CosmosDBAccount.listConnectionStringsAsync()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync()"
|
|
returns:
|
|
description: "the connection strings for the specified Azure CosmosDB database account"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountListConnectionStringsResult?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountListConnectionStringsResult&text=DatabaseAccountListConnectionStringsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listKeys()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listKeys()"
|
|
name: "listKeys()"
|
|
nameWithType: "CosmosDBAccount.listKeys()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract DatabaseAccountListKeysResult listKeys()"
|
|
returns:
|
|
description: "the access keys for the specified Azure CosmosDB database account"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountListKeysResult?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountListKeysResult&text=DatabaseAccountListKeysResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listKeysAsync()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listKeysAsync()"
|
|
name: "listKeysAsync()"
|
|
nameWithType: "CosmosDBAccount.listKeysAsync()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<DatabaseAccountListKeysResult> listKeysAsync()"
|
|
returns:
|
|
description: "the access keys for the specified Azure CosmosDB database account"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountListKeysResult?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountListKeysResult&text=DatabaseAccountListKeysResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateEndpointConnection()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateEndpointConnection()"
|
|
name: "listPrivateEndpointConnection()"
|
|
nameWithType: "CosmosDBAccount.listPrivateEndpointConnection()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Map<String,PrivateEndpointConnection> listPrivateEndpointConnection()"
|
|
returns:
|
|
description: "all private endpoint connection in the account."
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection?alt=com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection&text=PrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateEndpointConnectionAsync()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateEndpointConnectionAsync()"
|
|
name: "listPrivateEndpointConnectionAsync()"
|
|
nameWithType: "CosmosDBAccount.listPrivateEndpointConnectionAsync()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<Map<String,PrivateEndpointConnection>> listPrivateEndpointConnectionAsync()"
|
|
returns:
|
|
description: "all private endpoint connection in the account."
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection?alt=com.microsoft.azure.management.cosmosdb.PrivateEndpointConnection&text=PrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateLinkResources()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateLinkResources()"
|
|
name: "listPrivateLinkResources()"
|
|
nameWithType: "CosmosDBAccount.listPrivateLinkResources()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract List<PrivateLinkResource> listPrivateLinkResources()"
|
|
returns:
|
|
description: "all private link resources in the account."
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateLinkResource?alt=com.microsoft.azure.management.cosmosdb.PrivateLinkResource&text=PrivateLinkResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateLinkResourcesAsync()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listPrivateLinkResourcesAsync()"
|
|
name: "listPrivateLinkResourcesAsync()"
|
|
nameWithType: "CosmosDBAccount.listPrivateLinkResourcesAsync()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<List<PrivateLinkResource>> listPrivateLinkResourcesAsync()"
|
|
returns:
|
|
description: "all private link resources in the account."
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.PrivateLinkResource?alt=com.microsoft.azure.management.cosmosdb.PrivateLinkResource&text=PrivateLinkResource\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listReadOnlyKeys()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listReadOnlyKeys()"
|
|
name: "listReadOnlyKeys()"
|
|
nameWithType: "CosmosDBAccount.listReadOnlyKeys()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys()"
|
|
returns:
|
|
description: "the read-only access keys for the specified Azure CosmosDB database account"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountListReadOnlyKeysResult?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountListReadOnlyKeysResult&text=DatabaseAccountListReadOnlyKeysResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listReadOnlyKeysAsync()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listReadOnlyKeysAsync()"
|
|
name: "listReadOnlyKeysAsync()"
|
|
nameWithType: "CosmosDBAccount.listReadOnlyKeysAsync()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync()"
|
|
returns:
|
|
description: "the read-only access keys for the specified Azure CosmosDB database account"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountListReadOnlyKeysResult?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountListReadOnlyKeysResult&text=DatabaseAccountListReadOnlyKeysResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listSqlDatabases()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listSqlDatabases()"
|
|
name: "listSqlDatabases()"
|
|
nameWithType: "CosmosDBAccount.listSqlDatabases()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract List<SqlDatabase> listSqlDatabases()"
|
|
returns:
|
|
description: "the list of Azure Cosmos DB SQL databases"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.SqlDatabase?alt=com.microsoft.azure.management.cosmosdb.SqlDatabase&text=SqlDatabase\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listSqlDatabasesAsync()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.listSqlDatabasesAsync()"
|
|
name: "listSqlDatabasesAsync()"
|
|
nameWithType: "CosmosDBAccount.listSqlDatabasesAsync()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<List<SqlDatabase>> listSqlDatabasesAsync()"
|
|
returns:
|
|
description: "the list of Azure Cosmos DB SQL databases"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.SqlDatabase?alt=com.microsoft.azure.management.cosmosdb.SqlDatabase&text=SqlDatabase\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.multipleWriteLocationsEnabled()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.multipleWriteLocationsEnabled()"
|
|
name: "multipleWriteLocationsEnabled()"
|
|
nameWithType: "CosmosDBAccount.multipleWriteLocationsEnabled()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract boolean multipleWriteLocationsEnabled()"
|
|
returns:
|
|
description: "whether write is enabled for multiple locations or not"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.offlineRegion(com.microsoft.azure.management.resources.fluentcore.arm.Region)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.offlineRegion(Region region)"
|
|
name: "offlineRegion(Region region)"
|
|
nameWithType: "CosmosDBAccount.offlineRegion(Region region)"
|
|
summary: "It takes offline the specified region for the current Azure Cosmos DB database account."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Cosmos DB region"
|
|
name: "region"
|
|
type: "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.Region?alt=com.microsoft.azure.management.resources.fluentcore.arm.Region&text=Region\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract void offlineRegion(Region region)"
|
|
desc: "It takes offline the specified region for the current Azure Cosmos DB database account."
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.offlineRegionAsync(com.microsoft.azure.management.resources.fluentcore.arm.Region)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.offlineRegionAsync(Region region)"
|
|
name: "offlineRegionAsync(Region region)"
|
|
nameWithType: "CosmosDBAccount.offlineRegionAsync(Region region)"
|
|
summary: "Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Cosmos DB region"
|
|
name: "region"
|
|
type: "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.Region?alt=com.microsoft.azure.management.resources.fluentcore.arm.Region&text=Region\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Completable offlineRegionAsync(Region region)"
|
|
desc: "Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account."
|
|
returns:
|
|
description: "a representation of the deferred computation of this call"
|
|
type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.onlineRegion(com.microsoft.azure.management.resources.fluentcore.arm.Region)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.onlineRegion(Region region)"
|
|
name: "onlineRegion(Region region)"
|
|
nameWithType: "CosmosDBAccount.onlineRegion(Region region)"
|
|
summary: "It brings online the specified region for the current Azure Cosmos DB database account."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Cosmos DB region"
|
|
name: "region"
|
|
type: "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.Region?alt=com.microsoft.azure.management.resources.fluentcore.arm.Region&text=Region\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract void onlineRegion(Region region)"
|
|
desc: "It brings online the specified region for the current Azure Cosmos DB database account."
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.onlineRegionAsync(com.microsoft.azure.management.resources.fluentcore.arm.Region)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.onlineRegionAsync(Region region)"
|
|
name: "onlineRegionAsync(Region region)"
|
|
nameWithType: "CosmosDBAccount.onlineRegionAsync(Region region)"
|
|
summary: "Asynchronously it brings online the specified region for the current Azure Cosmos DB database account."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Cosmos DB region"
|
|
name: "region"
|
|
type: "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.Region?alt=com.microsoft.azure.management.resources.fluentcore.arm.Region&text=Region\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Completable onlineRegionAsync(Region region)"
|
|
desc: "Asynchronously it brings online the specified region for the current Azure Cosmos DB database account."
|
|
returns:
|
|
description: "a representation of the deferred computation of this call"
|
|
type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.readableReplications()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.readableReplications()"
|
|
name: "readableReplications()"
|
|
nameWithType: "CosmosDBAccount.readableReplications()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract List<Location> readableReplications()"
|
|
returns:
|
|
description: "an array that contains the readable georeplication locations enabled for the CosmosDB account"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.regenerateKey(com.microsoft.azure.management.cosmosdb.KeyKind)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.regenerateKey(KeyKind keyKind)"
|
|
name: "regenerateKey(KeyKind keyKind)"
|
|
nameWithType: "CosmosDBAccount.regenerateKey(KeyKind keyKind)"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the key kind"
|
|
name: "keyKind"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.KeyKind?alt=com.microsoft.azure.management.cosmosdb.KeyKind&text=KeyKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract void regenerateKey(KeyKind keyKind)"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.regenerateKeyAsync(com.microsoft.azure.management.cosmosdb.KeyKind)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.regenerateKeyAsync(KeyKind keyKind)"
|
|
name: "regenerateKeyAsync(KeyKind keyKind)"
|
|
nameWithType: "CosmosDBAccount.regenerateKeyAsync(KeyKind keyKind)"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the key kind"
|
|
name: "keyKind"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.KeyKind?alt=com.microsoft.azure.management.cosmosdb.KeyKind&text=KeyKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Completable regenerateKeyAsync(KeyKind keyKind)"
|
|
returns:
|
|
description: "a representation of the deferred computation of this call"
|
|
type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.virtualNetworkRules()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.virtualNetworkRules()"
|
|
name: "virtualNetworkRules()"
|
|
nameWithType: "CosmosDBAccount.virtualNetworkRules()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract List<VirtualNetworkRule> virtualNetworkRules()"
|
|
returns:
|
|
description: "a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set)"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.VirtualNetworkRule?alt=com.microsoft.azure.management.cosmosdb.VirtualNetworkRule&text=VirtualNetworkRule\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.writableReplications()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.CosmosDBAccount.writableReplications()"
|
|
name: "writableReplications()"
|
|
nameWithType: "CosmosDBAccount.writableReplications()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract List<Location> writableReplications()"
|
|
returns:
|
|
description: "an array that contains the writable georeplication locations enabled for the CosmosDB account"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "An immutable client-side representation of an Azure Cosmos DB."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager?alt=com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager&text=CosmosDBManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountGetResultsInner?alt=com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountGetResultsInner&text=DatabaseAccountGetResultsInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.CosmosDBAccount?alt=com.microsoft.azure.management.cosmosdb.CosmosDBAccount&text=CosmosDBAccount\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.CosmosDBAccount.Update?alt=com.microsoft.azure.management.cosmosdb.CosmosDBAccount.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.cosmosdb"
|
|
artifact: com.microsoft.azure:azure-mgmt-cosmosdb:1.41.4
|