azure-native.networkcloud.getCloudServicesNetwork

Get properties of the provided cloud services network. API Version: 2022-12-12-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>
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]
func LookupCloudServicesNetwork(ctx *Context, args *LookupCloudServicesNetworkArgs, opts ...InvokeOption) (*LookupCloudServicesNetworkResult, error)
func LookupCloudServicesNetworkOutput(ctx *Context, args *LookupCloudServicesNetworkOutputArgs, opts ...InvokeOption) LookupCloudServicesNetworkResultOutput

> 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)
}
public static CompletableFuture<GetCloudServicesNetworkResult> getCloudServicesNetwork(GetCloudServicesNetworkArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:networkcloud:getCloudServicesNetwork
  arguments:
    # arguments dictionary

The following arguments are supported:

CloudServicesNetworkName string

The name of the cloud services network.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

CloudServicesNetworkName string

The name of the cloud services network.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

cloudServicesNetworkName String

The name of the cloud services network.

resourceGroupName String

The name of the resource group. The name is case insensitive.

cloudServicesNetworkName string

The name of the cloud services network.

resourceGroupName string

The name of the resource group. The name is case insensitive.

cloud_services_network_name str

The name of the cloud services network.

resource_group_name str

The name of the resource group. The name is case insensitive.

cloudServicesNetworkName String

The name of the cloud services network.

resourceGroupName String

The name of the resource group. The name is case insensitive.

getCloudServicesNetwork Result

The following output properties are available:

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>

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. Ex - /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>

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.

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

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. Ex - /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

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.

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>

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. Ex - /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>

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.

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[]

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. Ex - /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[]

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.

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]

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. Ex - /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]

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.

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>

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. Ex - /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>

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 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 List<Pulumi.AzureNative.NetworkCloud.Inputs.EndpointDependencyResponse>

The list of endpoint dependencies.

Category 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 []EndpointDependencyResponse

The list of endpoint dependencies.

category 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 List<EndpointDependencyResponse>

The list of endpoint dependencies.

category 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 EndpointDependencyResponse[]

The list of endpoint dependencies.

category 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 Sequence[EndpointDependencyResponse]

The list of endpoint dependencies.

category 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 List<Property Map>

The list of endpoint dependencies.

EndpointDependencyResponse

DomainName string

The domain name of the dependency.

Port double

The port of this endpoint.

DomainName string

The domain name of the dependency.

Port float64

The port of this endpoint.

domainName String

The domain name of the dependency.

port Double

The port of this endpoint.

domainName string

The domain name of the dependency.

port number

The port of this endpoint.

domain_name str

The domain name of the dependency.

port float

The port of this endpoint.

domainName String

The domain name of the dependency.

port Number

The port of this endpoint.

ExtendedLocationResponse

Name string

The resource ID of the extended location on which the resource will be created.

Type string

The extended location type, for example, CustomLocation.

Name string

The resource ID of the extended location on which the resource will be created.

Type string

The extended location type, for example, CustomLocation.

name String

The resource ID of the extended location on which the resource will be created.

type String

The extended location type, for example, CustomLocation.

name string

The resource ID of the extended location on which the resource will be created.

type string

The extended location type, for example, CustomLocation.

name str

The resource ID of the extended location on which the resource will be created.

type str

The extended location type, for example, CustomLocation.

name String

The resource ID of the extended location on which the resource will be created.

type 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 pulumi/pulumi-azure-native
License
Apache-2.0