Linker - List

Service:

Service Connector

API-versie:

2022-11-01-preview

Retourneert een lijst met Linkers die verbinding maakt met de resource. die ondersteuning biedt voor het configureren van zowel de toepassing als de doelservice tijdens het inrichten van de resource.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceUri	path	True	string	De volledig gekwalificeerde Azure Resource Manager-id van de resource die moet worden verbonden.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ResourceList	Linkerdetails.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

LinkerList

Voorbeeldaanvraag

HTTP

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicelinker import ServiceLinkerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicelinker
# USAGE
    python linker_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 = ServiceLinkerManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.linker.list(
        resource_uri="subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2022-11-01-preview/examples/LinkerList.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

Voorbeeldrespons

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/links/linkName",
      "name": "linkName",
      "type": "Microsoft.ServiceLinker/links",
      "properties": {
        "authInfo": {
          "authType": "secret",
          "name": "username"
        },
        "targetService": {
          "type": "AzureResource",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
        }
      },
      "systemData": {
        "createdAt": "2020-07-12T22:05:09Z"
      }
    }
  ]
}

Definities

Name	Description
AccessKeyInfoBase	De toegangssleutel rechtstreeks vanuit de doelresource-eigenschappen, welke doelservice Azure Resource is, zoals Microsoft.Storage
accessKeyPermissions	Machtigingen van de accessKey. Read en Write zijn voor Azure Cosmos DB en Azure App Configuration, Listen, Send en Manage zijn voor Azure Event Hub en Azure Service Bus.
actionType	Facultatief. Geeft een openbare netwerkoplossing aan. Als dit is ingeschakeld, schakelt u de openbare netwerktoegang van de doelservice in. Probeer het best. De standaardwaarde is ingeschakeld. Als optOut wordt gebruikt, moet u de configuratie voor openbare netwerktoegang uitschakelen.
allowType	Toestaan dat Azure-services toegang hebben tot de doelservice, indien waar.
AuthType	Het verificatietype.
AzureKeyVaultProperties	De resource-eigenschappen wanneer het type Azure Key Vault is
AzureResource	De azure-resourcegegevens wanneer het doelservicetype AzureResource is
clientType	Het clienttype van de toepassing
ConfigurationInfo	De configuratiegegevens, gebruikt om configuraties te genereren of op te slaan in toepassingen
ConfluentBootstrapServer	De service-eigenschappen wanneer het doelservicetype ConfluentBootstrapServer is
ConfluentSchemaRegistry	De service-eigenschappen wanneer het doelservicetype ConfluentSchemaRegistry is
createdByType	Het type identiteit waarmee de resource is gemaakt.
DaprMetadata	De metagegevens van het dapr-onderdeel.
DaprProperties	Geeft enkele aanvullende eigenschappen voor dapr-clienttype aan
DeleteOrUpdateBehavior	Het opschoongedrag om aan te geven of de opschoonbewerking wordt uitgevoerd wanneer de resource wordt verwijderd of bijgewerkt
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FirewallRules	Firewallregels van de doelservice. verbindingen van de bronservice toestaan.
KeyVaultSecretReferenceSecretInfo	De geheime informatie wanneer het type keyVaultSecretReference is. Het is voor scenario dat de gebruiker een geheim biedt dat is opgeslagen in de sleutelkluis van de gebruiker en de bron Azure Kubernetes is. De resource-id van de sleutelkluis is gekoppeld aan secretStore.keyVaultId.
KeyVaultSecretUriSecretInfo	De geheime informatie wanneer het type keyVaultSecretUri is. Het is voor scenario dat de gebruiker een geheim biedt dat is opgeslagen in de sleutelkluis van de gebruiker en de bron Web App, Spring Cloud of Container App is.
LinkerResource	Linker van bron- en doelresource
PublicNetworkSolution	Geeft een openbare netwerkoplossing aan, inclusief firewallregels
ResourceList	De lijst met Linker.
SecretAuthInfo	De verificatiegegevens wanneer authType geheim is
SecretStore	Een optie voor het opslaan van geheime waarde op een veilige plaats
SecretType	Het geheime type.
SelfHostedServer	De service-eigenschappen wanneer het doelservicetype SelfHostedServer is
ServicePrincipalCertificateAuthInfo	De verificatiegegevens wanneer authType een servicePrincipal-certificaat is
ServicePrincipalSecretAuthInfo	De verificatiegegevens wanneer authType servicePrincipal secret is
SystemAssignedIdentityAuthInfo	De verificatiegegevens wanneer authType systemAssignedIdentity is
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserAccountAuthInfo	De verificatiegegevens wanneer authType een gebruikersaccount is
UserAssignedIdentityAuthInfo	De verificatiegegevens wanneer authType userAssignedIdentity is
ValueSecretInfo	De geheime informatie wanneer het type rawValue is. Dit is voor scenario's die de gebruiker het geheim invoert.
VNetSolution	De VNet-oplossing voor linker
vNetSolutionType	Type VNet-oplossing.

AccessKeyInfoBase

Object

De toegangssleutel rechtstreeks vanuit de doelresource-eigenschappen, welke doelservice Azure Resource is, zoals Microsoft.Storage

Name	Type	Description
authType	string: accessKey	Het verificatietype.
permissions	accessKeyPermissions[]	Machtigingen van de accessKey. Read en Write zijn voor Azure Cosmos DB en Azure App Configuration, Listen, Send en Manage zijn voor Azure Event Hub en Azure Service Bus.

accessKeyPermissions

Inventarisatie

Machtigingen van de accessKey. Read en Write zijn voor Azure Cosmos DB en Azure App Configuration, Listen, Send en Manage zijn voor Azure Event Hub en Azure Service Bus.

Waarde	Description
Read
Write
Listen
Send
Manage

actionType

Inventarisatie

Facultatief. Geeft een openbare netwerkoplossing aan. Als dit is ingeschakeld, schakelt u de openbare netwerktoegang van de doelservice in. Probeer het best. De standaardwaarde is ingeschakeld. Als optOut wordt gebruikt, moet u de configuratie voor openbare netwerktoegang uitschakelen.

Waarde	Description
enable
optOut

allowType

Inventarisatie

Toestaan dat Azure-services toegang hebben tot de doelservice, indien waar.

Waarde	Description
true
false

AuthType

Inventarisatie

Het verificatietype.

Waarde	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

AzureKeyVaultProperties

Object

De resource-eigenschappen wanneer het type Azure Key Vault is

Name	Type	Description
connectAsKubernetesCsiDriver	boolean	Waar als u verbinding maakt via het Kubernetes CSI-stuurprogramma.
type	string: KeyVault	Het azure-resourcetype.

AzureResource

Object

De azure-resourcegegevens wanneer het doelservicetype AzureResource is

Name	Type	Description
id	string	De id van azure-resource.
resourceProperties	AzureResourcePropertiesBase: AzureKeyVaultProperties	De gerelateerde eigenschappen van de Azure-resourceverbinding.
type	string: AzureResource	Het doelservicetype.

clientType

Inventarisatie

Het clienttype van de toepassing

Waarde	Description
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationInfo

Object

De configuratiegegevens, gebruikt om configuraties te genereren of op te slaan in toepassingen

Name	Type	Description
action	actionType	Geef optioneel aan of u configuraties wilt toepassen op de brontoepassing. Als dit is ingeschakeld, genereert u configuraties en wordt deze toegepast op de brontoepassing. De standaardwaarde is ingeschakeld. Als optOut wordt er geen configuratiewijziging aangebracht op de bron.
additionalConfigurations	object	Een woordenlijst met extra configuraties die moeten worden toegevoegd. Service genereert automatisch een set basisconfiguraties en deze eigenschap is om meer aangepaste configuraties volledig in te vullen
customizedKeys	object	Facultatief. Een woordenlijst met standaardsleutelnaam en aangepaste sleutelnaamtoewijzing. Als dit niet is opgegeven, wordt de standaardsleutelnaam gebruikt voor het genereren van configuraties
daprProperties	DaprProperties	Geeft enkele aanvullende eigenschappen voor dapr-clienttype aan
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert

ConfluentBootstrapServer

Object

De service-eigenschappen wanneer het doelservicetype ConfluentBootstrapServer is

Name	Type	Description
endpoint	string	Het eindpunt van de service.
type	string: ConfluentBootstrapServer	Het doelservicetype.

ConfluentSchemaRegistry

Object

De service-eigenschappen wanneer het doelservicetype ConfluentSchemaRegistry is

Name	Type	Description
endpoint	string	Het eindpunt van de service.
type	string: ConfluentSchemaRegistry	Het doelservicetype.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DaprMetadata

Object

De metagegevens van het dapr-onderdeel.

Name	Type	Description
name	string	Naam van metagegevenseigenschap.
secretRef	string	De geheime naam waar dapr waarde kan ophalen
value	string	Waarde van metagegevenseigenschap.

DaprProperties

Object

Geeft enkele aanvullende eigenschappen voor dapr-clienttype aan

Name	Type	Description
componentType	string	Het dapr-onderdeeltype
metadata	DaprMetadata[]	Aanvullende dapr-metagegevens
scopes	string[]	De dapr-onderdeelbereiken
secretStoreComponent	string	De naam van een geheime archief-dapr voor het ophalen van een geheim
version	string	De dapr-onderdeelversie

DeleteOrUpdateBehavior

Inventarisatie

Het opschoongedrag om aan te geven of de opschoonbewerking wordt uitgevoerd wanneer de resource wordt verwijderd of bijgewerkt

Waarde	Description
Default
ForcedCleanup

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

FirewallRules

Object

Firewallregels van de doelservice. verbindingen van de bronservice toestaan.

Name	Type	Description
azureServices	allowType	Toestaan dat Azure-services toegang hebben tot de doelservice, indien waar.
callerClientIP	allowType	Sta het IP-adres van de bellerclient toe om toegang te krijgen tot de doelservice, indien waar. de eigenschap wordt gebruikt bij het verbinden van de lokale toepassing met de doelservice.
ipRanges	string[]	Met deze waarde geeft u de set IP-adressen of IP-adresbereiken in CIDR-formulier op die moeten worden opgenomen als de lijst met toegestane client-IP-adressen voor een bepaald databaseaccount.

KeyVaultSecretReferenceSecretInfo

Object

De geheime informatie wanneer het type keyVaultSecretReference is. Het is voor scenario dat de gebruiker een geheim biedt dat is opgeslagen in de sleutelkluis van de gebruiker en de bron Azure Kubernetes is. De resource-id van de sleutelkluis is gekoppeld aan secretStore.keyVaultId.

Name	Type	Description
name	string	Naam van het Key Vault-geheim.
secretType	string: keyVaultSecretReference	Het geheime type.
version	string	Versie van het Key Vault-geheim.

KeyVaultSecretUriSecretInfo

Object

De geheime informatie wanneer het type keyVaultSecretUri is. Het is voor scenario dat de gebruiker een geheim biedt dat is opgeslagen in de sleutelkluis van de gebruiker en de bron Web App, Spring Cloud of Container App is.

Name	Type	Description
secretType	string: keyVaultSecretUri	Het geheime type.
value	string	URI naar het sleutelkluisgeheim

LinkerResource

Object

Linker van bron- en doelresource

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.authInfo	AuthInfoBase: AccessKeyInfoBase SecretAuthInfo ServicePrincipalCertificateAuthInfo ServicePrincipalSecretAuthInfo SystemAssignedIdentityAuthInfo UserAccountAuthInfo UserAssignedIdentityAuthInfo	Het verificatietype.
properties.clientType	clientType	Het clienttype van de toepassing
properties.configurationInfo	ConfigurationInfo	De verbindingsgegevens die worden gebruikt door toepassingen, waaronder geheimen, verbindingsreeksen.
properties.provisioningState	string	De inrichtingsstatus.
properties.publicNetworkSolution	PublicNetworkSolution	De netwerkoplossing.
properties.scope	string	verbindingsbereik in bronservice.
properties.secretStore	SecretStore	Een optie voor het opslaan van geheime waarde op een veilige plaats
properties.targetService	TargetServiceBase: AzureResource ConfluentBootstrapServer ConfluentSchemaRegistry SelfHostedServer	De eigenschappen van de doelservice
properties.vNetSolution	VNetSolution	De VNet-oplossing.
systemData	systemData	De systeemgegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PublicNetworkSolution

Object

Geeft een openbare netwerkoplossing aan, inclusief firewallregels

Name	Type	Description
action	actionType	Facultatief. Geeft een openbare netwerkoplossing aan. Als dit is ingeschakeld, schakelt u de openbare netwerktoegang van de doelservice in. Probeer het best. De standaardwaarde is ingeschakeld. Als optOut wordt gebruikt, moet u de configuratie voor openbare netwerktoegang uitschakelen.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking (zoals firewallregels) wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert
firewallRules	FirewallRules	Beschrijf firewallregels van de doelservice om ervoor te zorgen dat de brontoepassing verbinding kan maken met het doel.

ResourceList

Object

De lijst met Linker.

Name	Type	Description
nextLink	string	De Linker haalt de volgende pagina van de Linker-lijst op.
value	LinkerResource[]	De lijst met Linkers.

SecretAuthInfo

Object

De verificatiegegevens wanneer authType geheim is

Name	Type	Description
authType	string: secret	Het verificatietype.
name	string	Gebruikersnaam of accountnaam voor geheime verificatie.
secretInfo	SecretInfoBase: KeyVaultSecretReferenceSecretInfo KeyVaultSecretUriSecretInfo ValueSecretInfo	Wachtwoord- of sleutelkluisgeheim voor geheime verificatie.

SecretStore

Object

Een optie voor het opslaan van geheime waarde op een veilige plaats

Name	Type	Description
keyVaultId	string	De sleutelkluis-id voor het opslaan van geheim
keyVaultSecretName	string	De naam van het sleutelkluisgeheim voor het opslaan van een geheim, alleen geldig bij het opslaan van één geheim

SecretType

Inventarisatie

Het geheime type.

Waarde	Description
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Object

De service-eigenschappen wanneer het doelservicetype SelfHostedServer is

Name	Type	Description
endpoint	string	Het eindpunt van de service.
type	string: SelfHostedServer	Het doelservicetype.

ServicePrincipalCertificateAuthInfo

Object

De verificatiegegevens wanneer authType een servicePrincipal-certificaat is

Name	Type	Description
authType	string: servicePrincipalCertificate	Het verificatietype.
certificate	string	ServicePrincipal-certificaat voor servicePrincipal-verificatie.
clientId	string	ClientId van toepassing voor servicePrincipal-verificatie.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert
principalId	string	Principal-id voor servicePrincipal-verificatie.
roles	string[]	Optioneel, met deze waarde worden de Azure-rollen opgegeven die moeten worden toegewezen. Automatisch

ServicePrincipalSecretAuthInfo

Object

De verificatiegegevens wanneer authType servicePrincipal secret is

Name	Type	Description
authType	string: servicePrincipalSecret	Het verificatietype.
clientId	string	ServicePrincipal applicatie clientId for servicePrincipal auth.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert
principalId	string	Principal-id voor servicePrincipal-verificatie.
roles	string[]	Optioneel, met deze waarde worden de Azure-rollen opgegeven die moeten worden toegewezen. Automatisch
secret	string	Geheim voor servicePrincipal-verificatie.
userName	string	Gebruikersnaam die is gemaakt in de database die is toegewezen aan een gebruiker in AAD.

SystemAssignedIdentityAuthInfo

Object

De verificatiegegevens wanneer authType systemAssignedIdentity is

Name	Type	Description
authType	string: systemAssignedIdentity	Het verificatietype.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert
roles	string[]	Optioneel, met deze waarde wordt de Azure-rol opgegeven die moet worden toegewezen
userName	string	Gebruikersnaam die is gemaakt in de database die is toegewezen aan een gebruiker in AAD.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAccountAuthInfo

Object

De verificatiegegevens wanneer authType een gebruikersaccount is

Name	Type	Description
authType	string: userAccount	Het verificatietype.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert
principalId	string	Principal-id voor gebruikersaccount.
roles	string[]	Optioneel, met deze waarde worden de Azure-rollen opgegeven die moeten worden toegewezen. Automatisch
userName	string	Gebruikersnaam die is gemaakt in de database die is toegewezen aan een gebruiker in AAD.

UserAssignedIdentityAuthInfo

Object

De verificatiegegevens wanneer authType userAssignedIdentity is

Name	Type	Description
authType	string: userAssignedIdentity	Het verificatietype.
clientId	string	Client-id voor userAssignedIdentity.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert
roles	string[]	Optioneel, met deze waarde wordt de Azure-rol opgegeven die moet worden toegewezen
subscriptionId	string	Abonnements-id voor userAssignedIdentity.
userName	string	Gebruikersnaam die is gemaakt in de database die is toegewezen aan een gebruiker in AAD.

ValueSecretInfo

Object

De geheime informatie wanneer het type rawValue is. Dit is voor scenario's die de gebruiker het geheim invoert.

Name	Type	Description
secretType	string: rawValue	Het geheime type.
value	string	De werkelijke waarde van het geheim.

VNetSolution

Object

De VNet-oplossing voor linker

Name	Type	Description
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Geeft aan of u de vorige bewerking wilt opschonen wanneer Linker wordt bijgewerkt of verwijdert
type	vNetSolutionType	Type VNet-oplossing.

vNetSolutionType

Inventarisatie

Type VNet-oplossing.

Waarde	Description
serviceEndpoint
privateLink