特定のデータベースのすべての Azure Cosmos DB Gremlin グラフで行われたすべての変更のイベント フィードを表示します。 これは、コンテナーが誤って削除された場合に役立ちます。 この API には、'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' アクセス許可が必要です
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGraphs?api-version=2023-11-15
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGraphs?api-version=2023-11-15&restorableGremlinDatabaseRid={restorableGremlinDatabaseRid}&startTime={startTime}&endTime={endTime}
URI パラメーター
名前 |
/ |
必須 |
型 |
説明 |
instanceId
|
path |
True
|
string
|
復元可能なデータベース アカウントの InstanceId GUID。
|
location
|
path |
True
|
string
|
Cosmos DB リージョン。単語と各単語の間にスペースが大文字で表示されます。
|
subscriptionId
|
path |
True
|
string
|
ターゲット サブスクリプションの ID。
|
api-version
|
query |
True
|
string
|
この操作に使用する API バージョン。
|
endTime
|
query |
|
string
|
復元可能な Gremlin グラフイベント フィードの終了時刻。
|
restorableGremlinDatabaseRid
|
query |
|
string
|
Gremlin データベースのリソース ID。
|
startTime
|
query |
|
string
|
復元可能な Gremlin グラフイベント フィードの開始時刻。
|
応答
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 |
説明 |
user_impersonation
|
ユーザー アカウントの借用
|
例
CosmosDBRestorableGremlinGraphList
Sample Request
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs?api-version=2023-11-15&restorableGremlinDatabaseRid=PD5DALigDgw=
/**
* Samples for RestorableGremlinGraphs List.
*/
public final class Main {
/*
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
* CosmosDBRestorableGremlinGraphList.json
*/
/**
* Sample code: CosmosDBRestorableGremlinGraphList.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void cosmosDBRestorableGremlinGraphList(com.azure.resourcemanager.AzureResourceManager azure) {
azure.cosmosDBAccounts().manager().serviceClient().getRestorableGremlinGraphs().list("WestUS",
"98a570f2-63db-4117-91f0-366327b7b353", "PD5DALigDgw=", null, null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-cosmosdb
# USAGE
python cosmos_db_restorable_gremlin_graph_list.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = CosmosDBManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.restorable_gremlin_graphs.list(
location="WestUS",
instance_id="98a570f2-63db-4117-91f0-366327b7b353",
)
for item in response:
print(item)
# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinGraphList.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armcosmos_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinGraphList.json
func ExampleRestorableGremlinGraphsClient_NewListPager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewRestorableGremlinGraphsClient().NewListPager("WestUS", "98a570f2-63db-4117-91f0-366327b7b353", &armcosmos.RestorableGremlinGraphsClientListOptions{RestorableGremlinDatabaseRid: to.Ptr("PD5DALigDgw="),
StartTime: nil,
EndTime: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.RestorableGremlinGraphsListResult = armcosmos.RestorableGremlinGraphsListResult{
// Value: []*armcosmos.RestorableGremlinGraphGetResult{
// {
// Name: to.Ptr("79609a98-3394-41f8-911f-cfab0c075c86"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs"),
// ID: to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86"),
// Properties: &armcosmos.RestorableGremlinGraphProperties{
// Resource: &armcosmos.RestorableGremlinGraphPropertiesResource{
// Rid: to.Ptr("zAyAPQAAAA=="),
// CanUndelete: to.Ptr("invalid"),
// EventTimestamp: to.Ptr("2020-10-13T04:56:42Z"),
// OperationType: to.Ptr(armcosmos.OperationTypeCreate),
// OwnerID: to.Ptr("Graph1"),
// OwnerResourceID: to.Ptr("V18LoLrv-qA="),
// },
// },
// },
// {
// Name: to.Ptr("79609a98-3394-41f8-911f-cfab0c075c86"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs"),
// ID: to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86"),
// Properties: &armcosmos.RestorableGremlinGraphProperties{
// Resource: &armcosmos.RestorableGremlinGraphPropertiesResource{
// Rid: to.Ptr("zAyAPQAAAA=="),
// CanUndelete: to.Ptr("notRestorable"),
// CanUndeleteReason: to.Ptr("Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput."),
// EventTimestamp: to.Ptr("2020-10-13T04:56:42Z"),
// OperationType: to.Ptr(armcosmos.OperationTypeDelete),
// OwnerID: to.Ptr("Graph1"),
// OwnerResourceID: to.Ptr("V18LoLrv-qA="),
// },
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
*
* @summary Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinGraphList.json
*/
async function cosmosDbRestorableGremlinGraphList() {
const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
const location = "WestUS";
const instanceId = "98a570f2-63db-4117-91f0-366327b7b353";
const restorableGremlinDatabaseRid = "PD5DALigDgw=";
const options = {
restorableGremlinDatabaseRid,
};
const credential = new DefaultAzureCredential();
const client = new CosmosDBManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.restorableGremlinGraphs.list(location, instanceId, options)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs",
"name": "79609a98-3394-41f8-911f-cfab0c075c86",
"properties": {
"resource": {
"_rid": "zAyAPQAAAA==",
"eventTimestamp": "2020-10-13T04:56:42Z",
"ownerId": "Graph1",
"ownerResourceId": "V18LoLrv-qA=",
"operationType": "Create",
"canUndelete": "invalid"
}
}
},
{
"id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs",
"name": "79609a98-3394-41f8-911f-cfab0c075c86",
"properties": {
"resource": {
"_rid": "zAyAPQAAAA==",
"eventTimestamp": "2020-10-13T04:56:42Z",
"ownerId": "Graph1",
"ownerResourceId": "V18LoLrv-qA=",
"operationType": "Delete",
"canUndelete": "notRestorable",
"canUndeleteReason": "Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput."
}
}
}
]
}
定義
CloudError
サービスからのエラー応答。
ErrorResponse
エラー応答。
名前 |
型 |
説明 |
code
|
string
|
エラー コード。
|
message
|
string
|
操作が失敗した理由を示すエラー メッセージ。
|
OperationType
イベントの操作の種類を示す列挙。
名前 |
型 |
説明 |
Create
|
string
|
|
Delete
|
string
|
|
Recreate
|
string
|
|
Replace
|
string
|
|
SystemOperation
|
string
|
|
Resource
Azure Cosmos DB Gremlin グラフ イベントのリソース
名前 |
型 |
説明 |
_rid
|
string
|
システムによって生成されたプロパティ。 一意識別子。
|
canUndelete
|
string
|
このグラフが同じアカウントで復元可能かどうかを識別するための、このグラフの状態。
|
canUndeleteReason
|
string
|
このグラフを同じアカウントで復元できない理由。
|
eventTimestamp
|
string
|
このグラフ イベントが発生した時刻。
|
operationType
|
OperationType
|
このグラフ イベントの操作の種類。
|
ownerId
|
string
|
この Gremlin グラフの名前。
|
ownerResourceId
|
string
|
この Gremlin グラフのリソース ID。
|
RestorableGremlinGraphGetResult
Azure Cosmos DB Gremlin グラフ イベント
名前 |
型 |
説明 |
id
|
string
|
ARM リソースの一意のリソース識別子。
|
name
|
string
|
ARM リソースの名前。
|
properties.resource
|
Resource
|
Azure Cosmos DB Gremlin グラフ イベントのリソース
|
type
|
string
|
Azure リソースの種類。
|
RestorableGremlinGraphsListResult
Gremlin グラフ イベントとそのプロパティを含む List 操作応答。