Aspire.Hosting.Azure.Network
Official
📦 Aspire.Hosting.Azure.Network v13.2.0 45 Functions
21 Types
21 types and 37 members
Types
handle
AzureBicepResource 9 members handle
AzureEnvironmentResource 2 members handle
AzureNatGatewayResource 1 members handle
AzureNetworkSecurityGroupResource 1 members handle
AzurePrivateEndpointResource handle
AzureProvisioningResource 1 members handle
AzurePublicIPAddressResource handle
AzureResourceInfrastructure 3 members type
AzureSecurityRule 12 fields handle
AzureSubnetResource 7 members handle
AzureUserAssignedIdentityResource handle
AzureVirtualNetworkResource 1 members handle
BicepOutputReference 3 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzurePrivateEndpointTarget interface
IAzureResource 9 members Functions
function
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource function
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder function
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource function
addAzureVirtualNetwork builder Adds an Azure Virtual Network resource to the application model.
addAzureVirtualNetwork(name: string, addressPrefix?: string): AzureVirtualNetworkResource function
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource function
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource function
addNatGateway builder Adds an Azure NAT Gateway resource to the application model.
addNatGateway(name: string): AzureNatGatewayResource function
addNetworkSecurityGroup builder Adds an Azure Network Security Group resource to the application model.
addNetworkSecurityGroup(name: string): AzureNetworkSecurityGroupResource function
addPrivateEndpoint builder Adds an Azure Private Endpoint resource to an Azure subnet resource.
addPrivateEndpoint(target: IAzurePrivateEndpointTarget): AzurePrivateEndpointResource function
addPublicIPAddress builder Adds an Azure Public IP Address resource to the application model.
addPublicIPAddress(name: string): AzurePublicIPAddressResource function
addSubnet builder Adds an Azure subnet resource to an Azure Virtual Network resource.
addSubnet(name: string, addressPrefix: string, subnetName?: string): AzureSubnetResource function
allowInbound builder Adds an inbound allow rule to the Azure subnet resource's Network Security Group.
allowInbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource function
allowOutbound builder Adds an outbound allow rule to the Azure subnet resource's Network Security Group.
allowOutbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource function
asExisting builder Marks an Azure resource as existing in both run and publish modes by using parameter resources
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource function
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
denyInbound builder Adds an inbound deny rule to the Azure subnet resource's Network Security Group.
denyInbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource function
denyOutbound builder Adds an outbound deny rule to the Azure subnet resource's Network Security Group.
denyOutbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource function
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string function
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference function
isExisting Determines whether a resource is marked as existing
isExisting(): boolean function
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource function
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource function
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource function
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource function
withDelegatedSubnet builder Associates a delegated Azure subnet resource with an Azure resource that supports subnet delegation.
withDelegatedSubnet(subnet: AzureSubnetResource): IAzureDelegatedSubnetResource function
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment function
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment function
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource function
withNatGateway builder Associates an Azure NAT Gateway resource with an Azure subnet resource.
withNatGateway(natGateway: AzureNatGatewayResource): AzureSubnetResource function
withNetworkSecurityGroup builder Associates an Azure Network Security Group resource with an Azure subnet resource.
withNetworkSecurityGroup(nsg: AzureNetworkSecurityGroupResource): AzureSubnetResource function
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource function
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource function
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource function
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource function
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource function
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource function
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource function
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource function
withPublicIPAddress builder Associates an Azure Public IP Address resource with an Azure NAT Gateway resource.
withPublicIPAddress(publicIPAddress: AzurePublicIPAddressResource): AzureNatGatewayResource function
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource function
withSecurityRule builder Adds a security rule to an Azure Network Security Group resource.
withSecurityRule(rule: AzureSecurityRule): AzureNetworkSecurityGroupResource