Linker - Create Or Update

Utwórz lub zaktualizuj zasób konsolidatora.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}?api-version=2021-11-01-preview

Parametry identyfikatora URI

Name In Required Type Description
linkerName
path True
  • string

Nazwa zasobu konsolidatora.

resourceUri
path True
  • string

W pełni kwalifikowany identyfikator usługi Azure Resource Manager zasobu, który ma być połączony.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Name Type Description
properties.authInfo AuthInfoBase:

Typ uwierzytelniania.

properties.clientType

Typ klienta aplikacji

properties.secretStore

Opcja przechowywania wartości wpisu tajnego w bezpiecznym miejscu

properties.targetId
  • string

Identyfikator zasobu usługi docelowej.

properties.vNetSolution

Rozwiązanie sieci wirtualnej.

Odpowiedzi

Name Type Description
200 OK

Powodzenie.

201 Created

Długotrwała operacja.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

PutLink
PutLinkWithServiceEndpoint

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/linkers/linkName?api-version=2021-11-01-preview

{
  "properties": {
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secret": "secret"
    }
  }
}

Sample Response

{
  "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",
      "name": "name"
    },
    "targetId": "/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.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

PutLinkWithServiceEndpoint

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/linkers/linkName?api-version=2021-11-01-preview

{
  "properties": {
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secret": "secret"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    }
  }
}

Sample Response

{
  "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",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/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.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

Definicje

AuthType

Typ uwierzytelniania.

clientType

Typ klienta aplikacji

createdByType

Typ tożsamości, która utworzyła zasób.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

LinkerResource

Konsolidator zasobu źródłowego i docelowego

SecretAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType jest wpisem tajnym

SecretStore

Opcja przechowywania wartości wpisu tajnego w bezpiecznym miejscu

ServicePrincipalCertificateAuthInfo

Informacje o uwierzytelnianiu, gdy authType jest certyfikatem servicePrincipal

ServicePrincipalSecretAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType jest kluczem tajnym servicePrincipal

SystemAssignedIdentityAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType to systemAssignedIdentity

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

UserAssignedIdentityAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType to userAssignedIdentity

VNetSolution

Rozwiązanie sieci wirtualnej dla konsolidatora

vNetSolutionType

Typ rozwiązania sieci wirtualnej.

AuthType

Typ uwierzytelniania.

Name Type Description
secret
  • string
servicePrincipalCertificate
  • string
servicePrincipalSecret
  • string
systemAssignedIdentity
  • string
userAssignedIdentity
  • string

clientType

Typ klienta aplikacji

Name Type Description
django
  • string
dotnet
  • string
go
  • string
java
  • string
nodejs
  • string
none
  • string
php
  • string
python
  • string
ruby
  • string
springBoot
  • string

createdByType

Typ tożsamości, która utworzyła zasób.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

Szczegóły błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Name Type Description
error

Obiekt błędu.

LinkerResource

Konsolidator zasobu źródłowego i docelowego

Name Type Description
id
  • string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nazwa zasobu

properties.authInfo AuthInfoBase:

Typ uwierzytelniania.

properties.clientType

Typ klienta aplikacji

properties.provisioningState
  • string

Stan aprowizacji.

properties.secretStore

Opcja przechowywania wartości wpisu tajnego w bezpiecznym miejscu

properties.targetId
  • string

Identyfikator zasobu usługi docelowej.

properties.vNetSolution

Rozwiązanie sieci wirtualnej.

systemData

Dane systemowe.

type
  • string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

SecretAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType jest wpisem tajnym

Name Type Description
authType string:
  • secret

Typ uwierzytelniania.

name
  • string

Nazwa użytkownika lub nazwa konta dla uwierzytelniania tajnego.

secret
  • string

Hasło lub klucz konta dla uwierzytelniania tajnego.

SecretStore

Opcja przechowywania wartości wpisu tajnego w bezpiecznym miejscu

Name Type Description
keyVaultId
  • string

Identyfikator magazynu kluczy do przechowywania wpisu tajnego

ServicePrincipalCertificateAuthInfo

Informacje o uwierzytelnianiu, gdy authType jest certyfikatem servicePrincipal

Name Type Description
authType string:
  • servicePrincipalCertificate

Typ uwierzytelniania.

certificate
  • string

Certyfikat ServicePrincipal dla uwierzytelniania servicePrincipal.

clientId
  • string

Identyfikator clientId aplikacji dla uwierzytelniania servicePrincipal.

principalId
  • string

Identyfikator podmiotu zabezpieczeń dla uwierzytelniania servicePrincipal.

ServicePrincipalSecretAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType jest kluczem tajnym servicePrincipal

Name Type Description
authType string:
  • servicePrincipalSecret

Typ uwierzytelniania.

clientId
  • string

ServicePrincipal application clientId dla uwierzytelniania servicePrincipal.

principalId
  • string

Identyfikator podmiotu zabezpieczeń dla uwierzytelniania servicePrincipal.

secret
  • string

Wpis tajny dla uwierzytelniania servicePrincipal.

SystemAssignedIdentityAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType to systemAssignedIdentity

Name Type Description
authType string:
  • systemAssignedIdentity

Typ uwierzytelniania.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Name Type Description
createdAt
  • string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy
  • string

Tożsamość, która utworzyła zasób.

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt
  • string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy
  • string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentityAuthInfo

Informacje o uwierzytelnianiu, gdy typ authType to userAssignedIdentity

Name Type Description
authType string:
  • userAssignedIdentity

Typ uwierzytelniania.

clientId
  • string

Identyfikator klienta użytkownikaAssignedIdentity.

subscriptionId
  • string

Identyfikator subskrypcji użytkownikaAssignedIdentity.

VNetSolution

Rozwiązanie sieci wirtualnej dla konsolidatora

Name Type Description
type

Typ rozwiązania sieci wirtualnej.

vNetSolutionType

Typ rozwiązania sieci wirtualnej.

Name Type Description
privateLink
  • string
serviceEndpoint
  • string