Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2023-03-15-preview
- Najnowsza
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definicja zasobu Bicep
Typ zasobu databaseAccounts/gremlinDatabases można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-03-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
}
}
}
Wartości właściwości
databaseAccounts/gremlinDatabases
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep. |
ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| Nadrzędny | W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: databaseAccounts |
| identity | Tożsamość zasobu. | Identyfikator usługi zarządzanej |
| properties | Właściwości do tworzenia i aktualizowania bazy danych Gremlin usługi Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (wymagane) |
Identyfikator usługi zarządzanej
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Nazwa | Opis | Wartość |
|---|---|---|
| opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| zasób | Standardowy format JSON bazy danych Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (wymagane) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
| danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę. | int |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Nazwa | Opis | Wartość |
|---|---|---|
| createMode | Wyliczenie wskazujące tryb tworzenia zasobów. | "Wartość domyślna" "PointInTimeRestore" "Przywróć" |
| identyfikator | Nazwa bazy danych Gremlin usługi Cosmos DB | ciąg (wymagany) |
| restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
ResourceRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| restoreSource | Identyfikator konta bazy danych, z którego ma zostać zainicjowane przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | ciąg |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności. |
| Tworzenie konta usługi Azure Cosmos DB dla automatycznego skalowania interfejsu API języka Gremlin |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania. |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/gremlinDatabases można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
"apiVersion": "2023-03-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
}
}
}
Wartości właściwości
databaseAccounts/gremlinDatabases
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases" |
| apiVersion | Wersja interfejsu API zasobów | "2023-03-15-preview" |
| name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON. |
ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| identity | Tożsamość zasobu. | ManagedServiceIdentity |
| properties | Właściwości do tworzenia i aktualizowania bazy danych Gremlin usługi Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (wymagane) |
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Nazwa | Opis | Wartość |
|---|---|---|
| opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| zasób | Standardowy format JSON bazy danych Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (wymagane) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
| danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę. | int |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Nazwa | Opis | Wartość |
|---|---|---|
| createMode | Wyliczenie wskazujące tryb tworzenia zasobów. | "Wartość domyślna" "PointInTimeRestore" "Przywróć" |
| identyfikator | Nazwa bazy danych Gremlin usługi Cosmos DB | ciąg (wymagany) |
| restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
ResourceRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| restoreSource | Identyfikator konta bazy danych, z którego ma zostać zainicjowane przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | ciąg |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
| Tworzenie konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności. |
| Tworzenie konta usługi Azure Cosmos DB dla automatycznego skalowania interfejsu API języka Gremlin |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts/gremlinDatabases można wdrożyć z operacjami docelowymi:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-03-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
}
}
})
}
Wartości właściwości
databaseAccounts/gremlinDatabases
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-03-15-preview" |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: databaseAccounts |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. |
| identity | Tożsamość zasobu. | ManagedServiceIdentity |
| properties | Właściwości do tworzenia i aktualizowania bazy danych Gremlin usługi Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (wymagane) |
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Tablica identyfikatorów tożsamości użytkowników. |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Nazwa | Opis | Wartość |
|---|---|---|
| opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| zasób | Standardowy format JSON bazy danych Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (wymagane) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
| danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę. | int |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Nazwa | Opis | Wartość |
|---|---|---|
| createMode | Wyliczenie wskazujące tryb tworzenia zasobów. | "Wartość domyślna" "PointInTimeRestore" "Przywróć" |
| identyfikator | Nazwa bazy danych Gremlin usługi Cosmos DB | ciąg (wymagany) |
| restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
ResourceRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| restoreSource | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | ciąg |
| restoreTimestampInUtc | Czas przywrócenia konta (format ISO-8601). | ciąg |