Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. networkcloud
  5. getCloudServicesNetwork
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.networkcloud.getCloudServicesNetwork

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get properties of the provided cloud services network. Azure REST API version: 2023-10-01-preview.

Other available API versions: 2023-07-01, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

Using getCloudServicesNetwork

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCloudServicesNetwork(args: GetCloudServicesNetworkArgs, opts?: InvokeOptions): Promise<GetCloudServicesNetworkResult>
function getCloudServicesNetworkOutput(args: GetCloudServicesNetworkOutputArgs, opts?: InvokeOptions): Output<GetCloudServicesNetworkResult>
Copy
def get_cloud_services_network(cloud_services_network_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetCloudServicesNetworkResult
def get_cloud_services_network_output(cloud_services_network_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetCloudServicesNetworkResult]
Copy
func LookupCloudServicesNetwork(ctx *Context, args *LookupCloudServicesNetworkArgs, opts ...InvokeOption) (*LookupCloudServicesNetworkResult, error)
func LookupCloudServicesNetworkOutput(ctx *Context, args *LookupCloudServicesNetworkOutputArgs, opts ...InvokeOption) LookupCloudServicesNetworkResultOutput
Copy

> Note: This function is named LookupCloudServicesNetwork in the Go SDK.

public static class GetCloudServicesNetwork 
{
    public static Task<GetCloudServicesNetworkResult> InvokeAsync(GetCloudServicesNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudServicesNetworkResult> Invoke(GetCloudServicesNetworkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudServicesNetworkResult> getCloudServicesNetwork(GetCloudServicesNetworkArgs args, InvokeOptions options)
public static Output<GetCloudServicesNetworkResult> getCloudServicesNetwork(GetCloudServicesNetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:networkcloud:getCloudServicesNetwork
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CloudServicesNetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cloud services network.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CloudServicesNetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cloud services network.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cloudServicesNetworkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cloud services network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
cloudServicesNetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cloud services network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cloud_services_network_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cloud services network.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
cloudServicesNetworkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cloud services network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getCloudServicesNetwork Result

The following output properties are available:

AssociatedResourceIds List<string>
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
ClusterId string
The resource ID of the Network Cloud cluster this cloud services network is associated with.
DetailedStatus string
The more detailed status of the cloud services network.
DetailedStatusMessage string
The descriptive message about the current detailed status.
EnabledEgressEndpoints List<Pulumi.AzureNative.NetworkCloud.Outputs.EgressEndpointResponse>
The full list of additional and default egress endpoints that are currently enabled.
ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
The extended location of the cluster associated with the resource.
HybridAksClustersAssociatedIds List<string>
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
InterfaceName string
The name of the interface that will be present in the virtual machine to represent this network.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the cloud services network.
SystemData Pulumi.AzureNative.NetworkCloud.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualMachinesAssociatedIds List<string>
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.
AdditionalEgressEndpoints List<Pulumi.AzureNative.NetworkCloud.Outputs.EgressEndpointResponse>
The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.
EnableDefaultEgressEndpoints string
The indicator of whether the platform default endpoints are allowed for the egress traffic.
Tags Dictionary<string, string>
Resource tags.
AssociatedResourceIds []string
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
ClusterId string
The resource ID of the Network Cloud cluster this cloud services network is associated with.
DetailedStatus string
The more detailed status of the cloud services network.
DetailedStatusMessage string
The descriptive message about the current detailed status.
EnabledEgressEndpoints []EgressEndpointResponse
The full list of additional and default egress endpoints that are currently enabled.
ExtendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
HybridAksClustersAssociatedIds []string
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
InterfaceName string
The name of the interface that will be present in the virtual machine to represent this network.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the cloud services network.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualMachinesAssociatedIds []string
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.
AdditionalEgressEndpoints []EgressEndpointResponse
The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.
EnableDefaultEgressEndpoints string
The indicator of whether the platform default endpoints are allowed for the egress traffic.
Tags map[string]string
Resource tags.
associatedResourceIds List<String>
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId String
The resource ID of the Network Cloud cluster this cloud services network is associated with.
detailedStatus String
The more detailed status of the cloud services network.
detailedStatusMessage String
The descriptive message about the current detailed status.
enabledEgressEndpoints List<EgressEndpointResponse>
The full list of additional and default egress endpoints that are currently enabled.
extendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
hybridAksClustersAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
interfaceName String
The name of the interface that will be present in the virtual machine to represent this network.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the cloud services network.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachinesAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.
additionalEgressEndpoints List<EgressEndpointResponse>
The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.
enableDefaultEgressEndpoints String
The indicator of whether the platform default endpoints are allowed for the egress traffic.
tags Map<String,String>
Resource tags.
associatedResourceIds string[]
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId string
The resource ID of the Network Cloud cluster this cloud services network is associated with.
detailedStatus string
The more detailed status of the cloud services network.
detailedStatusMessage string
The descriptive message about the current detailed status.
enabledEgressEndpoints EgressEndpointResponse[]
The full list of additional and default egress endpoints that are currently enabled.
extendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
hybridAksClustersAssociatedIds string[]
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
interfaceName string
The name of the interface that will be present in the virtual machine to represent this network.
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
The provisioning state of the cloud services network.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachinesAssociatedIds string[]
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.
additionalEgressEndpoints EgressEndpointResponse[]
The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.
enableDefaultEgressEndpoints string
The indicator of whether the platform default endpoints are allowed for the egress traffic.
tags {[key: string]: string}
Resource tags.
associated_resource_ids Sequence[str]
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
cluster_id str
The resource ID of the Network Cloud cluster this cloud services network is associated with.
detailed_status str
The more detailed status of the cloud services network.
detailed_status_message str
The descriptive message about the current detailed status.
enabled_egress_endpoints Sequence[EgressEndpointResponse]
The full list of additional and default egress endpoints that are currently enabled.
extended_location ExtendedLocationResponse
The extended location of the cluster associated with the resource.
hybrid_aks_clusters_associated_ids Sequence[str]
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
interface_name str
The name of the interface that will be present in the virtual machine to represent this network.
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
The provisioning state of the cloud services network.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtual_machines_associated_ids Sequence[str]
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.
additional_egress_endpoints Sequence[EgressEndpointResponse]
The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.
enable_default_egress_endpoints str
The indicator of whether the platform default endpoints are allowed for the egress traffic.
tags Mapping[str, str]
Resource tags.
associatedResourceIds List<String>
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId String
The resource ID of the Network Cloud cluster this cloud services network is associated with.
detailedStatus String
The more detailed status of the cloud services network.
detailedStatusMessage String
The descriptive message about the current detailed status.
enabledEgressEndpoints List<Property Map>
The full list of additional and default egress endpoints that are currently enabled.
extendedLocation Property Map
The extended location of the cluster associated with the resource.
hybridAksClustersAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
interfaceName String
The name of the interface that will be present in the virtual machine to represent this network.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the cloud services network.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachinesAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.
additionalEgressEndpoints List<Property Map>
The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.
enableDefaultEgressEndpoints String
The indicator of whether the platform default endpoints are allowed for the egress traffic.
tags Map<String>
Resource tags.

Supporting Types

EgressEndpointResponse

Category This property is required. string
The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.
Endpoints This property is required. List<Pulumi.AzureNative.NetworkCloud.Inputs.EndpointDependencyResponse>
The list of endpoint dependencies.
Category This property is required. string
The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.
Endpoints This property is required. []EndpointDependencyResponse
The list of endpoint dependencies.
category This property is required. String
The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.
endpoints This property is required. List<EndpointDependencyResponse>
The list of endpoint dependencies.
category This property is required. string
The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.
endpoints This property is required. EndpointDependencyResponse[]
The list of endpoint dependencies.
category This property is required. str
The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.
endpoints This property is required. Sequence[EndpointDependencyResponse]
The list of endpoint dependencies.
category This property is required. String
The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.
endpoints This property is required. List<Property Map>
The list of endpoint dependencies.

EndpointDependencyResponse

DomainName This property is required. string
The domain name of the dependency.
Port double
The port of this endpoint.
DomainName This property is required. string
The domain name of the dependency.
Port float64
The port of this endpoint.
domainName This property is required. String
The domain name of the dependency.
port Double
The port of this endpoint.
domainName This property is required. string
The domain name of the dependency.
port number
The port of this endpoint.
domain_name This property is required. str
The domain name of the dependency.
port float
The port of this endpoint.
domainName This property is required. String
The domain name of the dependency.
port Number
The port of this endpoint.

ExtendedLocationResponse

Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.
name This property is required. string
The resource ID of the extended location on which the resource will be created.
type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. str
The resource ID of the extended location on which the resource will be created.
type This property is required. str
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native