Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ReleasePR @azure/arm-cosmosdb] Modify Cosmos Db Readme Global Api Ver to 2020-03 #8236

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk/cosmosdb/arm-cosmosdb/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2019 Microsoft
Copyright (c) 2020 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
export {
ARMProxyResource,
ARMResourceProperties,
AutoUpgradePolicyResource,
AzureEntityResource,
BaseResource,
Capability,
Expand All @@ -31,6 +32,7 @@ export {
ConflictResolutionPolicy,
ConsistencyPolicy,
ContainerPartitionKey,
CreateUpdateOptions,
DatabaseAccountCreateUpdateParameters,
DatabaseAccountGetResults,
ExcludedPath,
Expand Down Expand Up @@ -62,6 +64,7 @@ export {
PrivateEndpointProperty,
PrivateLinkResource,
PrivateLinkServiceConnectionStateProperty,
ProvisionedThroughputSettingsResource,
ProxyResource,
Resource,
SpatialSpec,
Expand Down Expand Up @@ -89,6 +92,7 @@ export {
TableGetPropertiesResource,
TableGetResults,
TableResource,
ThroughputPolicyResource,
ThroughputSettingsGetPropertiesResource,
ThroughputSettingsGetResults,
ThroughputSettingsResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
export {
ARMProxyResource,
ARMResourceProperties,
AutoUpgradePolicyResource,
AzureEntityResource,
BaseResource,
Capability,
Expand All @@ -29,6 +30,7 @@ export {
ConflictResolutionPolicy,
ConsistencyPolicy,
ContainerPartitionKey,
CreateUpdateOptions,
DatabaseAccountConnectionString,
DatabaseAccountCreateUpdateParameters,
DatabaseAccountGetResults,
Expand Down Expand Up @@ -79,6 +81,7 @@ export {
PrivateEndpointProperty,
PrivateLinkResource,
PrivateLinkServiceConnectionStateProperty,
ProvisionedThroughputSettingsResource,
ProxyResource,
RegionForOnlineOffline,
Resource,
Expand Down Expand Up @@ -107,6 +110,7 @@ export {
TableGetPropertiesResource,
TableGetResults,
TableResource,
ThroughputPolicyResource,
ThroughputSettingsGetPropertiesResource,
ThroughputSettingsGetResults,
ThroughputSettingsResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
export {
ARMProxyResource,
ARMResourceProperties,
AutoUpgradePolicyResource,
AzureEntityResource,
BaseResource,
Capability,
Expand All @@ -29,6 +30,7 @@ export {
ConflictResolutionPolicy,
ConsistencyPolicy,
ContainerPartitionKey,
CreateUpdateOptions,
DatabaseAccountCreateUpdateParameters,
DatabaseAccountGetResults,
ExcludedPath,
Expand Down Expand Up @@ -62,6 +64,7 @@ export {
PrivateEndpointProperty,
PrivateLinkResource,
PrivateLinkServiceConnectionStateProperty,
ProvisionedThroughputSettingsResource,
ProxyResource,
Resource,
SpatialSpec,
Expand Down Expand Up @@ -89,6 +92,7 @@ export {
TableGetPropertiesResource,
TableGetResults,
TableResource,
ThroughputPolicyResource,
ThroughputSettingsGetPropertiesResource,
ThroughputSettingsGetResults,
ThroughputSettingsResource,
Expand Down
143 changes: 126 additions & 17 deletions sdk/cosmosdb/arm-cosmosdb/src/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,15 @@ export interface DatabaseAccountGetResults extends ARMResourceProperties {
* keys
*/
disableKeyBasedMetadataWriteAccess?: boolean;
/**
* The URI of the key vault
*/
keyVaultKeyUri?: string;
/**
* Whether requests from Public Network are allowed. Possible values include: 'Enabled',
* 'Disabled'
*/
publicNetworkAccess?: PublicNetworkAccess;
}

/**
Expand Down Expand Up @@ -1059,14 +1068,65 @@ export interface ExtendedResourceProperties {
readonly _etag?: string;
}

/**
* Cosmos DB resource throughput policy
*/
export interface ThroughputPolicyResource {
/**
* Determines whether the ThroughputPolicy is active or not
*/
isEnabled?: boolean;
/**
* Represents the percentage by which throughput can increase every time throughput policy kicks
* in.
*/
incrementPercent?: number;
}

/**
* Cosmos DB resource auto-upgrade policy
*/
export interface AutoUpgradePolicyResource {
/**
* Represents throughput policy which service must adhere to for auto-upgrade
*/
throughputPolicy?: ThroughputPolicyResource;
}

/**
* Cosmos DB provisioned throughput settings object
*/
export interface ProvisionedThroughputSettingsResource {
/**
* Represents maximum throughput container can scale up to.
*/
maxThroughput: number;
/**
* Cosmos DB resource auto-upgrade policy
*/
autoUpgradePolicy?: AutoUpgradePolicyResource;
/**
* Represents target maximum throughput container can scale up to once offer is no longer in
* pending state.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly targetMaxThroughput?: number;
}

/**
* An interface representing ThroughputSettingsGetPropertiesResource.
*/
export interface ThroughputSettingsGetPropertiesResource {
/**
* Value of the Cosmos DB resource throughput
* Value of the Cosmos DB resource throughput. Either throughput is required or
* provisionedThroughputSettings is required, but not both.
*/
throughput?: number;
/**
* Cosmos DB resource for provisioned throughput settings. Either throughput is required or
* provisionedThroughputSettings is required, but not both.
*/
throughput: number;
provisionedThroughputSettings?: ProvisionedThroughputSettingsResource;
/**
* The minimum throughput of the resource
* **NOTE: This property will not be serialized. It can only be populated by the server.**
Expand Down Expand Up @@ -1162,6 +1222,15 @@ export interface DatabaseAccountCreateUpdateParameters extends ARMResourceProper
* keys
*/
disableKeyBasedMetadataWriteAccess?: boolean;
/**
* The URI of the key vault
*/
keyVaultKeyUri?: string;
/**
* Whether requests from Public Network are allowed. Possible values include: 'Enabled',
* 'Disabled'
*/
publicNetworkAccess?: PublicNetworkAccess;
}

/**
Expand Down Expand Up @@ -1223,6 +1292,15 @@ export interface DatabaseAccountUpdateParameters {
* keys
*/
disableKeyBasedMetadataWriteAccess?: boolean;
/**
* The URI of the key vault
*/
keyVaultKeyUri?: string;
/**
* Whether requests from Public Network are allowed. Possible values include: 'Enabled',
* 'Disabled'
*/
publicNetworkAccess?: PublicNetworkAccess;
}

/**
Expand Down Expand Up @@ -1295,13 +1373,20 @@ export interface DatabaseAccountRegenerateKeyParameters {
}

/**
* Cosmos DB resource throughput object
* Cosmos DB resource throughput object. Either throughput is required or
* provisionedThroughputSettings is required, but not both.
*/
export interface ThroughputSettingsResource {
/**
* Value of the Cosmos DB resource throughput
* Value of the Cosmos DB resource throughput. Either throughput is required or
* provisionedThroughputSettings is required, but not both.
*/
throughput?: number;
/**
* Cosmos DB resource for provisioned throughput settings. Either throughput is required or
* provisionedThroughputSettings is required, but not both.
*/
throughput: number;
provisionedThroughputSettings?: ProvisionedThroughputSettingsResource;
/**
* The minimum throughput of the resource
* **NOTE: This property will not be serialized. It can only be populated by the server.**
Expand Down Expand Up @@ -1334,6 +1419,22 @@ export interface SqlDatabaseResource {
id: string;
}

/**
* CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are
* "If-Match", "If-None-Match", "Session-Token" and "Throughput"
*/
export interface CreateUpdateOptions {
/**
* Request Units per second. For example, "throughput": "10000".
*/
throughput?: string;
/**
* Describes unknown properties. The value of an unknown property MUST be of type "string". Due
* to valid TS constraints we have modeled this as a union of `string | any`.
*/
[property: string]: string | any;
}

/**
* Parameters to create and update Cosmos DB SQL database.
*/
Expand All @@ -1346,7 +1447,7 @@ export interface SqlDatabaseCreateUpdateParameters extends ARMResourceProperties
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -1394,7 +1495,7 @@ export interface SqlContainerCreateUpdateParameters extends ARMResourcePropertie
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -1423,7 +1524,7 @@ export interface SqlStoredProcedureCreateUpdateParameters extends ARMResourcePro
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -1452,7 +1553,7 @@ export interface SqlUserDefinedFunctionCreateUpdateParameters extends ARMResourc
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -1490,7 +1591,7 @@ export interface SqlTriggerCreateUpdateParameters extends ARMResourceProperties
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand All @@ -1515,7 +1616,7 @@ export interface MongoDBDatabaseCreateUpdateParameters extends ARMResourceProper
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -1548,7 +1649,7 @@ export interface MongoDBCollectionCreateUpdateParameters extends ARMResourceProp
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand All @@ -1573,7 +1674,7 @@ export interface TableCreateUpdateParameters extends ARMResourceProperties {
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand All @@ -1598,7 +1699,7 @@ export interface CassandraKeyspaceCreateUpdateParameters extends ARMResourceProp
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -1631,7 +1732,7 @@ export interface CassandraTableCreateUpdateParameters extends ARMResourcePropert
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand All @@ -1656,7 +1757,7 @@ export interface GremlinDatabaseCreateUpdateParameters extends ARMResourceProper
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -1704,7 +1805,7 @@ export interface GremlinGraphCreateUpdateParameters extends ARMResourcePropertie
* A key-value pair of options to be applied for the request. This corresponds to the headers
* sent with the request.
*/
options: { [propertyName: string]: string };
options: CreateUpdateOptions;
}

/**
Expand Down Expand Up @@ -2397,6 +2498,14 @@ export type DefaultConsistencyLevel = 'Eventual' | 'Session' | 'BoundedStaleness
*/
export type ConnectorOffer = 'Small';

/**
* Defines values for PublicNetworkAccess.
* Possible values include: 'Enabled', 'Disabled'
* @readonly
* @enum {string}
*/
export type PublicNetworkAccess = 'Enabled' | 'Disabled';

/**
* Defines values for IndexingMode.
* Possible values include: 'Consistent', 'Lazy', 'None'
Expand Down
Loading