Azure Native v1.98.1, Mar 24 23

azure-native.networkcloud.getDefaultCniNetwork

Get properties of the provided default CNI network. API Version: 2022-12-12-preview.

Using getDefaultCniNetwork

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 getDefaultCniNetwork(args: GetDefaultCniNetworkArgs, opts?: InvokeOptions): Promise<GetDefaultCniNetworkResult>
function getDefaultCniNetworkOutput(args: GetDefaultCniNetworkOutputArgs, opts?: InvokeOptions): Output<GetDefaultCniNetworkResult>

def get_default_cni_network(default_cni_network_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDefaultCniNetworkResult
def get_default_cni_network_output(default_cni_network_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetDefaultCniNetworkResult]

func LookupDefaultCniNetwork(ctx *Context, args *LookupDefaultCniNetworkArgs, opts ...InvokeOption) (*LookupDefaultCniNetworkResult, error)
func LookupDefaultCniNetworkOutput(ctx *Context, args *LookupDefaultCniNetworkOutputArgs, opts ...InvokeOption) LookupDefaultCniNetworkResultOutput

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

public static class GetDefaultCniNetwork 
{
    public static Task<GetDefaultCniNetworkResult> InvokeAsync(GetDefaultCniNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetDefaultCniNetworkResult> Invoke(GetDefaultCniNetworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDefaultCniNetworkResult> getDefaultCniNetwork(GetDefaultCniNetworkArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:networkcloud:getDefaultCniNetwork
  arguments:
    # arguments dictionary

The following arguments are supported:

DefaultCniNetworkName string: The name of the default CNI network.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

DefaultCniNetworkName string: The name of the default CNI network.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

defaultCniNetworkName String: The name of the default CNI network.
resourceGroupName String: The name of the resource group. The name is case insensitive.

defaultCniNetworkName string: The name of the default CNI network.
resourceGroupName string: The name of the resource group. The name is case insensitive.

default_cni_network_name str: The name of the default CNI network.
resource_group_name str: The name of the resource group. The name is case insensitive.

defaultCniNetworkName String: The name of the default CNI network.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getDefaultCniNetwork Result

The following output properties are available:

ClusterId string: The resource ID of the Network Cloud cluster this default CNI network is associated with.
CniAsNumber double: The autonomous system number that the fabric expects to peer with, derived from the associated L3 isolation domain.
DetailedStatus string: The more detailed status of the default CNI network.
DetailedStatusMessage string: The descriptive message about the current detailed status.
ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse: The extended location of the cluster associated with the resource.
FabricBgpPeers List<Pulumi.AzureNative.NetworkCloud.Outputs.BgpPeerResponse>: The L3 isolation fabric BGP peering connectivity information necessary for BGP peering the Hybrid AKS Cluster with the switch fabric.
HybridAksClustersAssociatedIds List<string>: The list of Hybrid AKS cluster resource ID(s) that are associated with this default CNI 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.
L3IsolationDomainId string: The resource ID of the Network Fabric l3IsolationDomain.
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: The provisioning state of the default CNI 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"
Vlan double: The VLAN from the l3IsolationDomain that is used for this network.
CniBgpConfiguration Pulumi.AzureNative.NetworkCloud.Outputs.CniBgpConfigurationResponse
IpAllocationType string: The type of the IP address allocation.
Ipv4ConnectedPrefix string: The IPV4 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV4 or DualStack.
Ipv6ConnectedPrefix string: The IPV6 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV6 or DualStack.
Tags Dictionary<string, string>: Resource tags.

ClusterId string: The resource ID of the Network Cloud cluster this default CNI network is associated with.
CniAsNumber float64: The autonomous system number that the fabric expects to peer with, derived from the associated L3 isolation domain.
DetailedStatus string: The more detailed status of the default CNI network.
DetailedStatusMessage string: The descriptive message about the current detailed status.
ExtendedLocation ExtendedLocationResponse: The extended location of the cluster associated with the resource.
FabricBgpPeers []BgpPeerResponse: The L3 isolation fabric BGP peering connectivity information necessary for BGP peering the Hybrid AKS Cluster with the switch fabric.
HybridAksClustersAssociatedIds []string: The list of Hybrid AKS cluster resource ID(s) that are associated with this default CNI 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.
L3IsolationDomainId string: The resource ID of the Network Fabric l3IsolationDomain.
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: The provisioning state of the default CNI 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"
Vlan float64: The VLAN from the l3IsolationDomain that is used for this network.
CniBgpConfiguration CniBgpConfigurationResponse
IpAllocationType string: The type of the IP address allocation.
Ipv4ConnectedPrefix string: The IPV4 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV4 or DualStack.
Ipv6ConnectedPrefix string: The IPV6 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV6 or DualStack.
Tags map[string]string: Resource tags.

clusterId String: The resource ID of the Network Cloud cluster this default CNI network is associated with.
cniAsNumber Double: The autonomous system number that the fabric expects to peer with, derived from the associated L3 isolation domain.
detailedStatus String: The more detailed status of the default CNI network.
detailedStatusMessage String: The descriptive message about the current detailed status.
extendedLocation ExtendedLocationResponse: The extended location of the cluster associated with the resource.
fabricBgpPeers List<BgpPeerResponse>: The L3 isolation fabric BGP peering connectivity information necessary for BGP peering the Hybrid AKS Cluster with the switch fabric.
hybridAksClustersAssociatedIds List<String>: The list of Hybrid AKS cluster resource ID(s) that are associated with this default CNI 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.
l3IsolationDomainId String: The resource ID of the Network Fabric l3IsolationDomain.
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: The provisioning state of the default CNI 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"
vlan Double: The VLAN from the l3IsolationDomain that is used for this network.
cniBgpConfiguration CniBgpConfigurationResponse
ipAllocationType String: The type of the IP address allocation.
ipv4ConnectedPrefix String: The IPV4 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV4 or DualStack.
ipv6ConnectedPrefix String: The IPV6 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV6 or DualStack.
tags Map<String,String>: Resource tags.

clusterId string: The resource ID of the Network Cloud cluster this default CNI network is associated with.
cniAsNumber number: The autonomous system number that the fabric expects to peer with, derived from the associated L3 isolation domain.
detailedStatus string: The more detailed status of the default CNI network.
detailedStatusMessage string: The descriptive message about the current detailed status.
extendedLocation ExtendedLocationResponse: The extended location of the cluster associated with the resource.
fabricBgpPeers BgpPeerResponse[]: The L3 isolation fabric BGP peering connectivity information necessary for BGP peering the Hybrid AKS Cluster with the switch fabric.
hybridAksClustersAssociatedIds string[]: The list of Hybrid AKS cluster resource ID(s) that are associated with this default CNI 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.
l3IsolationDomainId string: The resource ID of the Network Fabric l3IsolationDomain.
location string: The geo-location where the resource lives
name string: The name of the resource
provisioningState string: The provisioning state of the default CNI 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"
vlan number: The VLAN from the l3IsolationDomain that is used for this network.
cniBgpConfiguration CniBgpConfigurationResponse
ipAllocationType string: The type of the IP address allocation.
ipv4ConnectedPrefix string: The IPV4 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV4 or DualStack.
ipv6ConnectedPrefix string: The IPV6 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV6 or DualStack.
tags {[key: string]: string}: Resource tags.

cluster_id str: The resource ID of the Network Cloud cluster this default CNI network is associated with.
cni_as_number float: The autonomous system number that the fabric expects to peer with, derived from the associated L3 isolation domain.
detailed_status str: The more detailed status of the default CNI network.
detailed_status_message str: The descriptive message about the current detailed status.
extended_location ExtendedLocationResponse: The extended location of the cluster associated with the resource.
fabric_bgp_peers Sequence[BgpPeerResponse]: The L3 isolation fabric BGP peering connectivity information necessary for BGP peering the Hybrid AKS Cluster with the switch fabric.
hybrid_aks_clusters_associated_ids Sequence[str]: The list of Hybrid AKS cluster resource ID(s) that are associated with this default CNI 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.
l3_isolation_domain_id str: The resource ID of the Network Fabric l3IsolationDomain.
location str: The geo-location where the resource lives
name str: The name of the resource
provisioning_state str: The provisioning state of the default CNI 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"
vlan float: The VLAN from the l3IsolationDomain that is used for this network.
cni_bgp_configuration CniBgpConfigurationResponse
ip_allocation_type str: The type of the IP address allocation.
ipv4_connected_prefix str: The IPV4 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV4 or DualStack.
ipv6_connected_prefix str: The IPV6 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV6 or DualStack.
tags Mapping[str, str]: Resource tags.

clusterId String: The resource ID of the Network Cloud cluster this default CNI network is associated with.
cniAsNumber Number: The autonomous system number that the fabric expects to peer with, derived from the associated L3 isolation domain.
detailedStatus String: The more detailed status of the default CNI network.
detailedStatusMessage String: The descriptive message about the current detailed status.
extendedLocation Property Map: The extended location of the cluster associated with the resource.
fabricBgpPeers List<Property Map>: The L3 isolation fabric BGP peering connectivity information necessary for BGP peering the Hybrid AKS Cluster with the switch fabric.
hybridAksClustersAssociatedIds List<String>: The list of Hybrid AKS cluster resource ID(s) that are associated with this default CNI 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.
l3IsolationDomainId String: The resource ID of the Network Fabric l3IsolationDomain.
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: The provisioning state of the default CNI 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"
vlan Number: The VLAN from the l3IsolationDomain that is used for this network.
cniBgpConfiguration Property Map
ipAllocationType String: The type of the IP address allocation.
ipv4ConnectedPrefix String: The IPV4 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV4 or DualStack.
ipv6ConnectedPrefix String: The IPV6 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type is IPV6 or DualStack.
tags Map<String>: Resource tags.

Supporting Types

BgpPeerResponse

AsNumber double: The ASN (Autonomous System Number) of the BGP peer.
PeerIp string: The IPv4 or IPv6 address to peer with the associated CNI Network. The IP version type will drive a peering with the same version type from the Default CNI Network. For example, IPv4 to IPv4 or IPv6 to IPv6.

AsNumber float64: The ASN (Autonomous System Number) of the BGP peer.
PeerIp string: The IPv4 or IPv6 address to peer with the associated CNI Network. The IP version type will drive a peering with the same version type from the Default CNI Network. For example, IPv4 to IPv4 or IPv6 to IPv6.

asNumber Double: The ASN (Autonomous System Number) of the BGP peer.
peerIp String: The IPv4 or IPv6 address to peer with the associated CNI Network. The IP version type will drive a peering with the same version type from the Default CNI Network. For example, IPv4 to IPv4 or IPv6 to IPv6.

asNumber number: The ASN (Autonomous System Number) of the BGP peer.
peerIp string: The IPv4 or IPv6 address to peer with the associated CNI Network. The IP version type will drive a peering with the same version type from the Default CNI Network. For example, IPv4 to IPv4 or IPv6 to IPv6.

as_number float: The ASN (Autonomous System Number) of the BGP peer.
peer_ip str: The IPv4 or IPv6 address to peer with the associated CNI Network. The IP version type will drive a peering with the same version type from the Default CNI Network. For example, IPv4 to IPv4 or IPv6 to IPv6.

asNumber Number: The ASN (Autonomous System Number) of the BGP peer.
peerIp String: The IPv4 or IPv6 address to peer with the associated CNI Network. The IP version type will drive a peering with the same version type from the Default CNI Network. For example, IPv4 to IPv4 or IPv6 to IPv6.

CniBgpConfigurationResponse

BgpPeers List<Pulumi.AzureNative.NetworkCloud.Inputs.BgpPeerResponse>: The list of BgpPeer entities that the Hybrid AKS cluster will peer with in addition to peering that occurs automatically with the switch fabric.
CommunityAdvertisements List<Pulumi.AzureNative.NetworkCloud.Inputs.CommunityAdvertisementResponse>: The list of prefix community advertisement properties. Each prefix community specifies a prefix, and the communities that should be associated with that prefix when it is announced.
ServiceExternalPrefixes List<string>: The subnet blocks in CIDR format for Kubernetes service external IPs to be advertised over BGP.
ServiceLoadBalancerPrefixes List<string>: The subnet blocks in CIDR format for Kubernetes load balancers. Load balancer IPs will only be advertised if they are within one of these blocks.

BgpPeers []BgpPeerResponse: The list of BgpPeer entities that the Hybrid AKS cluster will peer with in addition to peering that occurs automatically with the switch fabric.
CommunityAdvertisements []CommunityAdvertisementResponse: The list of prefix community advertisement properties. Each prefix community specifies a prefix, and the communities that should be associated with that prefix when it is announced.
ServiceExternalPrefixes []string: The subnet blocks in CIDR format for Kubernetes service external IPs to be advertised over BGP.
ServiceLoadBalancerPrefixes []string: The subnet blocks in CIDR format for Kubernetes load balancers. Load balancer IPs will only be advertised if they are within one of these blocks.

bgpPeers List<BgpPeerResponse>: The list of BgpPeer entities that the Hybrid AKS cluster will peer with in addition to peering that occurs automatically with the switch fabric.
communityAdvertisements List<CommunityAdvertisementResponse>: The list of prefix community advertisement properties. Each prefix community specifies a prefix, and the communities that should be associated with that prefix when it is announced.
serviceExternalPrefixes List<String>: The subnet blocks in CIDR format for Kubernetes service external IPs to be advertised over BGP.
serviceLoadBalancerPrefixes List<String>: The subnet blocks in CIDR format for Kubernetes load balancers. Load balancer IPs will only be advertised if they are within one of these blocks.

bgpPeers BgpPeerResponse[]: The list of BgpPeer entities that the Hybrid AKS cluster will peer with in addition to peering that occurs automatically with the switch fabric.
communityAdvertisements CommunityAdvertisementResponse[]: The list of prefix community advertisement properties. Each prefix community specifies a prefix, and the communities that should be associated with that prefix when it is announced.
serviceExternalPrefixes string[]: The subnet blocks in CIDR format for Kubernetes service external IPs to be advertised over BGP.
serviceLoadBalancerPrefixes string[]: The subnet blocks in CIDR format for Kubernetes load balancers. Load balancer IPs will only be advertised if they are within one of these blocks.

bgp_peers Sequence[BgpPeerResponse]: The list of BgpPeer entities that the Hybrid AKS cluster will peer with in addition to peering that occurs automatically with the switch fabric.
community_advertisements Sequence[CommunityAdvertisementResponse]: The list of prefix community advertisement properties. Each prefix community specifies a prefix, and the communities that should be associated with that prefix when it is announced.
service_external_prefixes Sequence[str]: The subnet blocks in CIDR format for Kubernetes service external IPs to be advertised over BGP.
service_load_balancer_prefixes Sequence[str]: The subnet blocks in CIDR format for Kubernetes load balancers. Load balancer IPs will only be advertised if they are within one of these blocks.

bgpPeers List<Property Map>: The list of BgpPeer entities that the Hybrid AKS cluster will peer with in addition to peering that occurs automatically with the switch fabric.
communityAdvertisements List<Property Map>: The list of prefix community advertisement properties. Each prefix community specifies a prefix, and the communities that should be associated with that prefix when it is announced.
serviceExternalPrefixes List<String>: The subnet blocks in CIDR format for Kubernetes service external IPs to be advertised over BGP.
serviceLoadBalancerPrefixes List<String>: The subnet blocks in CIDR format for Kubernetes load balancers. Load balancer IPs will only be advertised if they are within one of these blocks.

CommunityAdvertisementResponse

Communities List<string>: The list of community strings to announce with this prefix.
SubnetPrefix string: The subnet in CIDR format for which properties should be advertised.

Communities []string: The list of community strings to announce with this prefix.
SubnetPrefix string: The subnet in CIDR format for which properties should be advertised.

communities List<String>: The list of community strings to announce with this prefix.
subnetPrefix String: The subnet in CIDR format for which properties should be advertised.

communities string[]: The list of community strings to announce with this prefix.
subnetPrefix string: The subnet in CIDR format for which properties should be advertised.

communities Sequence[str]: The list of community strings to announce with this prefix.
subnet_prefix str: The subnet in CIDR format for which properties should be advertised.

communities List<String>: The list of community strings to announce with this prefix.
subnetPrefix String: The subnet in CIDR format for which properties should be advertised.

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