WebPubSubServiceProxy

Handle

📦 Aspire.Hosting.Azure.Provisioning.WebPubSub v13.6.0-preview.1.26478.8

interface WebPubSubServiceProxy {
  readonly externalIP: BicepValueProxy | string;
  readonly hostName: BicepValueProxy | string;
  readonly hostNamePrefix: BicepValueProxy | string;
  readonly id: BicepValueProxy;
  identity: WebPubSubManagedServiceIdentityProxy;
  isAadAuthDisabled: BicepValueProxy | boolean;
  isClientCertEnabled: BicepValueProxy | boolean;
  isLocalAuthDisabled: BicepValueProxy | boolean;
  liveTraceConfiguration: LiveTraceConfigurationProxy;
  location: BicepValueProxy;
  name: BicepValueProxy | string;
  networkAcls: WebPubSubNetworkAclsProxy;
  readonly privateEndpointConnections: Aspire_Hosting_Azure_Provisioning_WebPubSub_Generated_ListOfWebPubSubPrivateEndpointConnectionDataProxy;
  readonly provisioningState: BicepValueProxy | WebPubSubProvisioningState;
  publicNetworkAccess: BicepValueProxy | string;
  readonly publicPort: BicepValueProxy | number;
  resourceLogCategories: Aspire_Hosting_Azure_Provisioning_WebPubSub_Generated_ListOfResourceLogCategoryProxy;
  readonly serverPort: BicepValueProxy | number;
  readonly sharedPrivateLinkResources: Aspire_Hosting_Azure_Provisioning_WebPubSub_Generated_ListOfWebPubSubSharedPrivateLinkDataProxy;
  sku: BillingInfoSkuProxy;
  readonly systemData: WebPubSubSystemDataProxy;
  tags: Aspire_Hosting_Azure_Provisioning_WebPubSub_Generated_DictionaryOfStringProxy;
  readonly version: BicepValueProxy | string;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearIsAadAuthDisabled(): void;
  clearIsClientCertEnabled(): void;
  clearIsLocalAuthDisabled(): void;
  clearLocation(): void;
  clearName(): void;
  clearPublicNetworkAccess(): void;
  createRoleAssignment(
      role: WebPubSubBuiltInRoleProxy,
      principalType: BicepValueProxy | RoleManagementPrincipalType,
      principalId: BicepValueProxy | guid,
      bicepIdentifierSuffix: string): WebPubSubRoleAssignmentProxy;
  getKeys(): WebPubSubKeysProxy;
}

44 members

Properties

propertyexternalIPBicepValueProxy | stringget

Gets the ExternalIP provisioning property.

propertyhostNameBicepValueProxy | stringget

Gets the HostName provisioning property.

propertyhostNamePrefixBicepValueProxy | stringget

Gets the HostNamePrefix provisioning property.

propertyidBicepValueProxyget

Gets the Id provisioning property.

propertyidentityWebPubSubManagedServiceIdentityProxyget · set

Gets or sets the Identity provisioning property.

propertyisAadAuthDisabledBicepValueProxy | booleanget · set

Gets or sets the IsAadAuthDisabled provisioning property.

propertyisClientCertEnabledBicepValueProxy | booleanget · set

Gets or sets the IsClientCertEnabled provisioning property.

propertyisLocalAuthDisabledBicepValueProxy | booleanget · set

Gets or sets the IsLocalAuthDisabled provisioning property.

propertyliveTraceConfigurationLiveTraceConfigurationProxyget · set

Gets or sets the LiveTraceConfiguration provisioning property.

propertylocationBicepValueProxyget · set

Gets or sets the Location provisioning property.

propertynameBicepValueProxy | stringget · set

Gets or sets the Name provisioning property.

propertynetworkAclsWebPubSubNetworkAclsProxyget · set

Gets or sets the NetworkAcls provisioning property.

propertyprivateEndpointConnectionsAspire_Hosting_Azure_Provisioning_WebPubSub_Generated_ListOfWebPubSubPrivateEndpointConnectionDataProxyget

Gets the PrivateEndpointConnections provisioning property.

propertyprovisioningStateBicepValueProxy | WebPubSubProvisioningStateget

Gets the ProvisioningState provisioning property.

propertypublicNetworkAccessBicepValueProxy | stringget · set

Gets or sets the PublicNetworkAccess provisioning property.

propertypublicPortBicepValueProxy | numberget

Gets the PublicPort provisioning property.

propertyresourceLogCategoriesAspire_Hosting_Azure_Provisioning_WebPubSub_Generated_ListOfResourceLogCategoryProxyget · set

Gets or sets the ResourceLogCategories provisioning property.

propertyserverPortBicepValueProxy | numberget

Gets the ServerPort provisioning property.

propertysharedPrivateLinkResourcesAspire_Hosting_Azure_Provisioning_WebPubSub_Generated_ListOfWebPubSubSharedPrivateLinkDataProxyget

Gets the SharedPrivateLinkResources provisioning property.

propertyskuBillingInfoSkuProxyget · set

Gets or sets the Sku provisioning property.

propertysystemDataWebPubSubSystemDataProxyget

Gets the SystemData provisioning property.

propertytagsAspire_Hosting_Azure_Provisioning_WebPubSub_Generated_DictionaryOfStringProxyget · set

Gets or sets the Tags provisioning property.

propertyversionBicepValueProxy | stringget

Gets the Version provisioning property.

Methods

methodaddTo

Adds this provisioning resource to the Azure resource infrastructure.

addTo(infrastructure: AzureResourceInfrastructure): void

Parameters

infrastructureAzureResourceInfrastructure

methodclearIsAadAuthDisabled

Clears the IsAadAuthDisabled provisioning property.

clearIsAadAuthDisabled(): void

methodclearIsClientCertEnabled

Clears the IsClientCertEnabled provisioning property.

clearIsClientCertEnabled(): void

methodclearIsLocalAuthDisabled

Clears the IsLocalAuthDisabled provisioning property.

clearIsLocalAuthDisabled(): void

methodclearLocation

Clears the Location provisioning property.

clearLocation(): void

methodclearName

Clears the Name provisioning property.

clearName(): void

methodclearPublicNetworkAccess

Clears the PublicNetworkAccess provisioning property.

clearPublicNetworkAccess(): void

methodcreateRoleAssignment

Invokes CreateRoleAssignment on the WebPubSubService provisioning model.

createRoleAssignment(
    role: WebPubSubBuiltInRoleProxy,
    principalType: BicepValueProxy | RoleManagementPrincipalType,
    principalId: BicepValueProxy | guid,
    bicepIdentifierSuffix: string): WebPubSubRoleAssignmentProxy

Parameters

roleWebPubSubBuiltInRoleProxy

principalTypeBicepValueProxy | RoleManagementPrincipalType

principalIdBicepValueProxy | guid

bicepIdentifierSuffixstring

Returns

WebPubSubRoleAssignmentProxy

methodgetKeys

Invokes GetKeys on the WebPubSubService provisioning model.

getKeys(): WebPubSubKeysProxy

Returns

WebPubSubKeysProxy