Hybrid Connections - List Keys

Service:

Relay

API-versie:

2024-01-01

Primaire en secundaire verbindingsreeksen voor de hybride verbinding.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2024-01-01

URI-parameters

Name	In	Vereist	Type	Description
authorizationRuleName	path	True	string minLength: 1	De naam van de autorisatieregel.
hybridConnectionName	path	True	string minLength: 1	De naam van de hybride verbinding.
namespaceName	path	True	string minLength: 6 maxLength: 50	De naamruimtenaam
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	AccessKeys	Aanvraag voor het ophalen van verbindingsreeksen voor de hybride verbinding is geslaagd.
Other Status Codes	ErrorResponse	Relay-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

RelayHybridConnectionAuthorizationRuleListKey

Voorbeeldaanvraag

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/hybridConnections/example-Relay-Hybrid-01/authorizationRules/example-RelayAuthRules-01/listKeys?api-version=2024-01-01

Voorbeeldrespons

Statuscode:

200

{
  "primaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "example-RelayAuthRules-01"
}

Definities

Name	Description
AccessKeys	Naamruimte/Relay-verbindingsreeks
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

AccessKeys

Object

Naamruimte/Relay-verbindingsreeks

Name	Type	Description
keyName	string	Een tekenreeks die de autorisatieregel beschrijft.
primaryConnectionString	string	Primaire verbindingsreeks van de gemaakte autorisatieregel voor naamruimte.
primaryKey	string	Een met base64 gecodeerde 256-bits primaire sleutel voor het ondertekenen en valideren van het SAS-token.
secondaryConnectionString	string	Secundaire verbindingsreeks van de gemaakte autorisatieregel voor naamruimte.
secondaryKey	string	Een met base64 gecodeerde 256-bits secundaire sleutel voor het ondertekenen en valideren van het SAS-token.

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.