Namespaces - Create Or Update

Usługa:: Relay

Wersja interfejsu API:: 2024-01-01

Tworzenie przestrzeni nazw usługi Azure Relay.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string minLength: 6 maxLength: 50	Nazwa przestrzeni nazw
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
properties.privateEndpointConnections		PrivateEndpointConnection[]	Lista połączeń prywatnych punktów końcowych.
properties.publicNetworkAccess		PublicNetworkAccess	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
sku		Sku	Jednostka SKU przestrzeni nazw.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RelayNamespace	Operacja aktualizacji zasobu "RelayNamespace" powiodła się
201 Created	RelayNamespace	Operacja tworzenia zasobu "RelayNamespace" zakończyła się pomyślnie Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

200 OK

RelayNamespace

Operacja aktualizacji zasobu "RelayNamespace" powiodła się

201 Created

RelayNamespace

Operacja tworzenia zasobu "RelayNamespace" zakończyła się pomyślnie

Nagłówki

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

RelayNamespaceCreate

Przykładowe żądanie

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849?api-version=2024-01-01

{
  "location": "South Central US",
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "name": "example-RelayNamespace-5849",
  "type": "Microsoft.Relay/Namespaces",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849",
  "location": "South Central US",
  "properties": {
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849",
    "provisioningState": "Created",
    "serviceBusEndpoint": "https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"
  },
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Kod stanu:: 201

{
  "name": "example-RelayNamespace-5849",
  "type": "Microsoft.Relay/Namespaces",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849",
  "location": "South Central US",
  "properties": {
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849",
    "provisioningState": "Created",
    "serviceBusEndpoint": "https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"
  },
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Definicje

Nazwa	Opis
ConnectionState	Informacje o stanie połączenia.
createdByType	Typ tożsamości, która utworzyła zasób.
EndPointProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
PrivateEndpoint	Informacje dotyczące prywatnego punktu końcowego.
PrivateEndpointConnection	Właściwości elementu PrivateEndpointConnection.
PrivateLinkConnectionStatus	Stan połączenia.
PublicNetworkAccess	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
RelayNamespace	Opis zasobu przestrzeni nazw.
Sku	Jednostka SKU przestrzeni nazw.
SkuName	Nazwa tej jednostki SKU.
SkuTier	Warstwa tej jednostki SKU.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ConnectionState

Objekt

Informacje o stanie połączenia.

Nazwa	Typ	Opis
description	string	Opis stanu połączenia.
status	PrivateLinkConnectionStatus	Stan połączenia.

createdByType

Wyliczanie

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

Wartość	Opis
User
Application
ManagedIdentity
Key

EndPointProvisioningState

Wyliczanie

Stan aprowizacji połączenia prywatnego punktu końcowego.

Wartość	Opis
Creating
Updating
Deleting
Succeeded
Canceled
Failed

ErrorAdditionalInfo

Objekt

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

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

PrivateEndpoint

Objekt

Informacje dotyczące prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Objekt

Właściwości elementu PrivateEndpointConnection.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego dla tego połączenia.
properties.privateLinkServiceConnectionState	ConnectionState	Szczegółowe informacje o stanie połączenia.
properties.provisioningState	EndPointProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Wyliczanie

Stan połączenia.

Wartość	Opis
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Wyliczanie

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.

Wartość	Opis
Enabled
Disabled
SecuredByPerimeter

RelayNamespace

Objekt

Opis zasobu przestrzeni nazw.

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.createdAt	string (date-time)		Czas utworzenia przestrzeni nazw.
properties.metricId	string		Identyfikator metryk usługi Azure Insights.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista połączeń prywatnych punktów końcowych.
properties.provisioningState	string		Stan aprowizacji przestrzeni nazw.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
properties.serviceBusEndpoint	string		Punkt końcowy, którego można użyć do wykonywania operacji usługi Service Bus.
properties.status	string		Stan przestrzeni nazw.
properties.updatedAt	string (date-time)		Czas aktualizacji przestrzeni nazw.
sku	Sku		Jednostka SKU przestrzeni nazw.
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

Sku

Objekt

Jednostka SKU przestrzeni nazw.

Nazwa	Typ	Opis
name	SkuName	Nazwa tej jednostki SKU.
tier	SkuTier	Warstwa tej jednostki SKU.

SkuName

Wyliczanie

Nazwa tej jednostki SKU.

Wartość	Opis
Standard

SkuTier

Wyliczanie

Warstwa tej jednostki SKU.

Wartość	Opis
Standard

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij przez

Namespaces - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

RelayNamespaceCreate

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ConnectionState

createdByType

EndPointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

RelayNamespace

Sku

SkuName

SkuTier

systemData