Namespaces - Update

Dienst:

Relay

API-Version:

2024-01-01

Erstellt oder aktualisiert einen Namespace. Nach der Erstellung ist das Ressourcenmanifest dieses Namespace unveränderlich. Dieser Vorgang ist idempotent.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}?api-version=2024-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string minLength: 6 maxLength: 50	Der Namespacename
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.privateEndpointConnections	PrivateEndpointConnection[]	Liste der privaten Endpunktverbindungen.
properties.publicNetworkAccess	PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
sku	Sku	SKU des Namespace.
tags	object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	RelayNamespace	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
201 Created	RelayNamespace	Der Erstellungsvorgang der Ressource 'RelayNamespace' war erfolgreich
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RelayNameSpaceUpdate

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01?api-version=2024-01-01

{
  "tags": {
    "tag3": "value3",
    "tag4": "value4",
    "tag5": "value5",
    "tag6": "value6"
  }
}

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "example-RelayRelayNamespace-01",
  "type": "Microsoft.Relay/Namespaces",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01",
  "location": "West US",
  "properties": {
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relayrelaynamespace-01",
    "provisioningState": "Succeeded"
  },
  "tags": {
    "tag3": "value3",
    "tag4": "value4",
    "tag5": "value5",
    "tag6": "value6"
  }
}

Statuscode:

201

{
  "name": "example-RelayRelayNamespace-01",
  "type": "Microsoft.Relay/Namespaces",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01",
  "location": "West US",
  "properties": {
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relayrelaynamespace-01",
    "provisioningState": "Succeeded"
  },
  "tags": {
    "tag3": "value3",
    "tag4": "value4",
    "tag5": "value5",
    "tag6": "value6"
  }
}

Definitionen

Name	Beschreibung
ConnectionState	ConnectionState-Informationen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PrivateEndpoint	PrivateEndpoint-Informationen.
PrivateEndpointConnection	Eigenschaften der PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status der Verbindung.
PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
RelayNamespace	Beschreibung einer Namespaceressource.
RelayUpdateParameters	Beschreibung einer Namespaceressource.
Sku	SKU des Namespace.
SkuName	Name dieser SKU.
SkuTier	Die Ebene dieser SKU.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

ConnectionState

Objekt

ConnectionState-Informationen.

Name	Typ	Beschreibung
description	string	Beschreibung des Verbindungszustands.
status	PrivateLinkConnectionStatus	Status der Verbindung.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

EndPointProvisioningState

Enumeration

Bereitstellungsstatus der privaten Endpunktverbindung.

Wert	Beschreibung
Creating
Updating
Deleting
Succeeded
Canceled
Failed

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PrivateEndpoint

Objekt

PrivateEndpoint-Informationen.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte.

PrivateEndpointConnection

Objekt

Eigenschaften der PrivateEndpointConnection.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.privateEndpoint	PrivateEndpoint	Die Private Endpoint-Ressource für diese Verbindung.
properties.privateLinkServiceConnectionState	ConnectionState	Details zum Status der Verbindung.
properties.provisioningState	EndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Enumeration

Status der Verbindung.

Wert	Beschreibung
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Enumeration

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.

Wert	Beschreibung
Enabled
Disabled
SecuredByPerimeter

RelayNamespace

Objekt

Beschreibung einer Namespaceressource.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Der Name der Ressource
properties.createdAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace erstellt wurde.
properties.metricId	string		Bezeichner für Azure Insights-Metriken.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der privaten Endpunktverbindungen.
properties.provisioningState	string		Bereitstellungsstatus des Namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
properties.serviceBusEndpoint	string		Endpunkt, den Sie zum Ausführen von ServiceBus-Vorgängen verwenden können.
properties.status	string		Status des Namespace.
properties.updatedAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace aktualisiert wurde.
sku	Sku		SKU des Namespace.
systemData	systemData		Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

RelayUpdateParameters

Objekt

Beschreibung einer Namespaceressource.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Der Name der Ressource
properties.createdAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace erstellt wurde.
properties.metricId	string		Bezeichner für Azure Insights-Metriken.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der privaten Endpunktverbindungen.
properties.provisioningState	string		Bereitstellungsstatus des Namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
properties.serviceBusEndpoint	string		Endpunkt, den Sie zum Ausführen von ServiceBus-Vorgängen verwenden können.
properties.status	string		Status des Namespace.
properties.updatedAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace aktualisiert wurde.
sku	Sku		SKU des Namespace.
systemData	systemData		Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Sku

Objekt

SKU des Namespace.

Name	Typ	Beschreibung
name	SkuName	Name dieser SKU.
tier	SkuTier	Die Ebene dieser SKU.

SkuName

Enumeration

Name dieser SKU.

Wert	Beschreibung
Standard

SkuTier

Enumeration

Die Ebene dieser SKU.

Wert	Beschreibung
Standard

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.