@azure/arm-relay package

Clases

RelayAPI

Interfaces

AccessKeys

Cadena de conexión de espacio de nombres o retransmisión

AuthorizationRule

Elemento único en una operación List o Get AuthorizationRule

AuthorizationRuleProperties

Propiedades proporcionadas para crear o actualizar AuthorizationRule

CheckNameAvailability

Descripción de las propiedades de la solicitud de disponibilidad check name.

CheckNameAvailabilityResult

Descripción de las propiedades de la solicitud de disponibilidad check name.

ConnectionState

Información de ConnectionState.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores.

HybridConnection

Descripción del recurso de conexión híbrida.

HybridConnectionProperties

Propiedades de HybridConnection.

HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams

Parámetros opcionales.

HybridConnectionsCreateOrUpdateOptionalParams

Parámetros opcionales.

HybridConnectionsDeleteAuthorizationRuleOptionalParams

Parámetros opcionales.

HybridConnectionsDeleteOptionalParams

Parámetros opcionales.

HybridConnectionsGetAuthorizationRuleOptionalParams

Parámetros opcionales.

HybridConnectionsGetOptionalParams

Parámetros opcionales.

HybridConnectionsListAuthorizationRulesOptionalParams

Parámetros opcionales.

HybridConnectionsListByNamespaceOptionalParams

Parámetros opcionales.

HybridConnectionsListKeysOptionalParams

Parámetros opcionales.

HybridConnectionsOperations

Interfaz que representa una operación HybridConnections.

HybridConnectionsRegenerateKeysOptionalParams

Parámetros opcionales.

NWRuleSetIpRules

Respuesta de la operación Enumerar espacio de nombres.

NamespacesCheckNameAvailabilityOptionalParams

Parámetros opcionales.

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Parámetros opcionales.

NamespacesCreateOrUpdateNetworkRuleSetOptionalParams

Parámetros opcionales.

NamespacesCreateOrUpdateOptionalParams

Parámetros opcionales.

NamespacesDeleteAuthorizationRuleOptionalParams

Parámetros opcionales.

NamespacesDeleteOptionalParams

Parámetros opcionales.

NamespacesGetAuthorizationRuleOptionalParams

Parámetros opcionales.

NamespacesGetNetworkRuleSetOptionalParams

Parámetros opcionales.

NamespacesGetOptionalParams

Parámetros opcionales.

NamespacesListAuthorizationRulesOptionalParams

Parámetros opcionales.

NamespacesListByResourceGroupOptionalParams

Parámetros opcionales.

NamespacesListKeysOptionalParams

Parámetros opcionales.

NamespacesListOptionalParams

Parámetros opcionales.

NamespacesOperations

Interfaz que representa una operación de espacios de nombres.

NamespacesRegenerateKeysOptionalParams

Parámetros opcionales.

NamespacesUpdateOptionalParams

Parámetros opcionales.

NetworkRuleSet

Descripción del recurso de tema.

NetworkRuleSetProperties

Propiedades networkRuleSet

Operation

Detalles de una operación de API REST, devuelta desde la API de operaciones del proveedor de recursos

OperationDisplay

Información de visualización localizada para una operación.

OperationsListOptionalParams

Parámetros opcionales.

OperationsOperations

Interfaz que representa una operación de operaciones.

PageSettings

Opciones para el método byPage

PagedAsyncIterableIterator

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

PrivateEndpoint

Información de PrivateEndpoint.

PrivateEndpointConnection

Propiedades de PrivateEndpointConnection.

PrivateEndpointConnectionProperties

Propiedades del recurso de conexión de punto final privado.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Parámetros opcionales.

PrivateEndpointConnectionsDeleteOptionalParams

Parámetros opcionales.

PrivateEndpointConnectionsGetOptionalParams

Parámetros opcionales.

PrivateEndpointConnectionsListOptionalParams

Parámetros opcionales.

PrivateEndpointConnectionsOperations

Interfaz que representa una operación PrivateEndpointConnections.

PrivateLinkResource

Recurso que admite funcionalidades de vínculo privado.

PrivateLinkResourceProperties

Propiedades de PrivateLinkResource

PrivateLinkResourcesGetOptionalParams

Parámetros opcionales.

PrivateLinkResourcesListOptionalParams

Parámetros opcionales.

PrivateLinkResourcesListResult

Resultado de la operación Enumerar recursos de vínculo privado.

PrivateLinkResourcesOperations

Interfaz que representa una operación PrivateLinkResources.

ProxyResource

Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación

RegenerateAccessKeyParameters

Los parámetros proporcionados a la operación de regla de autorización de regeneración especifican qué clave se debe restablecer.

RelayAPIOptionalParams

Parámetros opcionales para el cliente.

RelayNamespace

Descripción de un recurso de espacio de nombres.

RelayNamespaceProperties

Propiedades del espacio de nombres.

RelayUpdateParameters

Descripción de un recurso de espacio de nombres.

Resource

Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager

ResourceNamespacePatch

Definición de recurso.

RestorePollerOptions
SimplePollerLike

Un sondeo sencillo que se puede usar para sondear una operación de larga duración.

Sku

SKU del espacio de nombres.

SystemData

Metadatos relativos a la creación y última modificación del recurso.

TrackedResource

La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación".

WcfRelay

Descripción del recurso de retransmisión WCF.

WcfRelayProperties

Propiedades de la retransmisión WCF.

wCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams

Parámetros opcionales.

wCFRelaysCreateOrUpdateOptionalParams

Parámetros opcionales.

wCFRelaysDeleteAuthorizationRuleOptionalParams

Parámetros opcionales.

wCFRelaysDeleteOptionalParams

Parámetros opcionales.

wCFRelaysGetAuthorizationRuleOptionalParams

Parámetros opcionales.

wCFRelaysGetOptionalParams

Parámetros opcionales.

wCFRelaysListAuthorizationRulesOptionalParams

Parámetros opcionales.

wCFRelaysListByNamespaceOptionalParams

Parámetros opcionales.

wCFRelaysListKeysOptionalParams

Parámetros opcionales.

wCFRelaysOperations

Interfaz que representa operaciones de wCFRelays.

wCFRelaysRegenerateKeysOptionalParams

Parámetros opcionales.

Alias de tipos

AccessRights

Tipo de derechos de acceso

ActionType

Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.
KnownActionType se puede usar indistintamente con ActionType; esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

interno: las acciones son para las API solo internas.

AzureSupportedClouds

Los valores admitidos para la configuración de nube como un tipo literal de cadena

ContinuablePage

Interfaz que describe una página de resultados.

CreatedByType

Tipo de entidad que creó el recurso.
KnownCreatedByType se puede usar indistintamente con CreatedByType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Usuario: un usuario creó la entidad.
Application: la entidad la creó una aplicación.
ManagedIdentity: la entidad se creó mediante una identidad administrada.
Key: la entidad se creó mediante una clave.

DefaultAction

Acción predeterminada para el conjunto de reglas de red
KnownDefaultAction se puede usar indistintamente con DefaultAction, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Permitir
Deny

EndPointProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.
KnownEndPointProvisioningState se puede usar indistintamente con EndPointProvisioningState, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Crear
Actualizando
Eliminando
Éxito
Cancelado
Error

KeyType

Clave de acceso que se va a regenerar.
KnownKeyType se puede usar indistintamente con KeyType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

PrimaryKey
SecondaryKey

NetworkRuleIPAction

La acción del filtro IP
KnownNetworkRuleIPAction se puede usar indistintamente con NetworkRuleIPAction, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Permitir

Origin

El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema"
KnownOrigin se puede usar indistintamente con Origin, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

usuario: indica que un usuario inicia la operación.
del sistema: indica que un sistema inicia la operación.
usuario,del sistema: indica que un usuario o sistema inicia la operación.

PrivateLinkConnectionStatus

Estado de la conexión.
KnownPrivateLinkConnectionStatus se puede usar indistintamente con PrivateLinkConnectionStatus, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Pendiente
Aprobado
Rejected
desconectado

PublicNetworkAccess

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.
KnownPublicNetworkAccess se puede usar indistintamente con PublicNetworkAccess, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Habilitado
Deshabilitado
SecuredByPerimeter

Relaytype

Tipo de retransmisión WCF.

SkuName

Nombre de esta SKU.
KnownSkuName se puede usar indistintamente con SkuName, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Estándar

SkuTier

Nivel de esta SKU.
KnownSkuTier se puede usar indistintamente con SkuTier, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Estándar

UnavailableReason

Especifica el motivo de la falta de disponibilidad del servicio.
KnownUnavailableReason puede usarse indistintamente con UnavailableReason, este enum contiene los valores conocidos que soporta el servicio.

Valores conocidos admitidos por el servicio

None
Nombre inválido
SubscriptionIsDisabled
NombreInUso
NombreInLockdown
DemasiadosEspacioEnSuscripciónCorrienteT

Enumeraciones

AzureClouds

Un enum para describir los entornos de Azure Cloud.

KnownAccessRights

Los valores conocidos de AccessRights que acepta el servicio.

KnownActionType

Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.

KnownCreatedByType

Tipo de entidad que creó el recurso.

KnownDefaultAction

Acción predeterminada para el conjunto de reglas de red

KnownEndPointProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

KnownKeyType

Clave de acceso que se va a regenerar.

KnownNetworkRuleIPAction

Acción de filtro IP

KnownOrigin

El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema"

KnownPrivateLinkConnectionStatus

Estado de la conexión.

KnownPublicNetworkAccess

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.

KnownSkuName

Nombre de esta SKU.

KnownSkuTier

Nivel de esta SKU.

KnownUnavailableReason

Especifica el motivo de la falta de disponibilidad del servicio.

KnownVersions

Las versiones de API disponibles.

Funciones

isRestError(unknown)

Typeguard para RestError

restorePoller<TResponse, TResult>(RelayAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

Variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

Detalles de la función

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parámetros

e

unknown

Algo capturado por una cláusula catch.

Devoluciones

e

restorePoller<TResponse, TResult>(RelayAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

function restorePoller<TResponse, TResult>(client: RelayAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parámetros

client
RelayAPI
serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Devoluciones

PollerLike<OperationState<TResult>, TResult>

Detalles de variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

RestError: RestErrorConstructor

Tipo