Skip to content

Service connector keyvault secret #18258

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 15, 2022
Merged

Service connector keyvault secret #18258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions ...resource-manager/Microsoft.ServiceLinker/preview/2022-01-01-preview/examples/PutLink.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@
"properties": {
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
},
"authInfo": {
"authType": "secret",
"name": "name",
"secret": "secret"
"secret": {
"secretType": "rawValue",
"value": "secret"
}
}
}
}
Expand All @@ -29,7 +32,7 @@
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
}
}
}
Expand All @@ -45,7 +48,7 @@
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
}
}
}
Expand Down
61 changes: 61 additions & 0 deletions ...r/Microsoft.ServiceLinker/preview/2022-01-01-preview/examples/PutLinkWithSecretStore.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"parameters": {
"api-version": "2022-01-01-preview",
"resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app",
"linkerName": "linkName",
"parameters": {
"properties": {
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
},
"authInfo": {
"authType": "secret"
},
"secretStore": {
"keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
}
}
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
"type": "Microsoft.ServiceLinker/links",
"name": "linkName",
"properties": {
"authInfo": {
"authType": "secret"
},
"secretStore": {
"keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
}
}
}
},
"201": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
"type": "Microsoft.ServiceLinker/links",
"name": "linkName",
"properties": {
"authInfo": {
"authType": "secret"
},
"secretStore": {
"keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
}
}
}
}
}
}
20 changes: 7 additions & 13 deletions ...crosoft.ServiceLinker/preview/2022-01-01-preview/examples/PutLinkWithServiceEndpoint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
"properties": {
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
},
"authInfo": {
"authType": "secret",
"name": "name",
"secret": "secret"
"secret": {
"secretType": "keyVaultSecretUri",
"value": "https://vault-name.vault.azure.net/secrets/secret-name/00000000000000000000000000000000"
}
},
"vNetSolution": {
"type": "serviceEndpoint"
},
"secretStore": {
"keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
}
}
}
Expand All @@ -37,12 +37,9 @@
"vNetSolution": {
"type": "serviceEndpoint"
},
"secretStore": {
"keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
}
}
}
Expand All @@ -60,12 +57,9 @@
"vNetSolution": {
"type": "serviceEndpoint"
},
"secretStore": {
"keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
}
}
}
Expand Down
86 changes: 84 additions & 2 deletions ...er/resource-manager/Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@
},
"PutLinkWithServiceEndpoint": {
"$ref": "./examples/PutLinkWithServiceEndpoint.json"
},
"PutLinkWithSecretStore": {
"$ref": "./examples/PutLinkWithSecretStore.json"
}
},
"parameters": [
Expand Down Expand Up @@ -521,6 +524,86 @@
"modelAsString": true
}
},
"SecretType": {
"description": "The secret type.",
"type": "string",
"enum": [
"rawValue",
"keyVaultSecretUri",
"keyVaultSecretReference"
],
"x-ms-enum": {
"name": "SecretType",
"modelAsString": true
}
},
"SecretInfoBase": {
"description": "The secret info",
"discriminator": "secretType",
"type": "object",
"properties": {
"secretType": {
"description": "The secret type.",
"$ref": "#/definitions/SecretType"
}
},
"required": [
"secretType"
]
},
"ValueSecretInfo": {
"x-ms-discriminator-value": "rawValue",
"type": "object",
"description": "The secret info when type is rawValue. It's for scenarios that user input the secret.",
"allOf": [
{
"$ref": "#/definitions/SecretInfoBase"
}
],
"properties": {
"value": {
"description": "The actual value of the secret.",
"type": "string",
"x-ms-secret": true
}
}
},
"KeyVaultSecretReferenceSecretInfo": {
"x-ms-discriminator-value": "keyVaultSecretReference",
"type": "object",
"description": "The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId.",
"allOf": [
{
"$ref": "#/definitions/SecretInfoBase"
}
],
"properties": {
"name": {
"description": "Name of the Key Vault secret.",
"type": "string"
},
"version": {
"description": "Version of the Key Vault secret.",
"type": "string"
}
}
},
"KeyVaultSecretUriSecretInfo": {
"x-ms-discriminator-value": "keyVaultSecretUri",
"type": "object",
"description": "The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App.",
"allOf": [
{
"$ref": "#/definitions/SecretInfoBase"
}
],
"properties": {
"value": {
"description": "URI to the keyvault secret",
"type": "string"
}
}
},
"AuthInfoBase": {
"description": "The authentication info",
"discriminator": "authType",
Expand Down Expand Up @@ -551,8 +634,7 @@
},
"secret": {
"description": "Password or account key for secret auth.",
"type": "string",
"x-ms-secret": true
"$ref": "#/definitions/SecretInfoBase"
}
}
},
Expand Down