1. Packages
  2. Azure Native
  3. API Docs
  4. hybridnetwork
  5. getSiteNetworkService
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

azure-native.hybridnetwork.getSiteNetworkService

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

    Gets information about the specified site network service. Azure REST API version: 2023-09-01.

    Using getSiteNetworkService

    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 getSiteNetworkService(args: GetSiteNetworkServiceArgs, opts?: InvokeOptions): Promise<GetSiteNetworkServiceResult>
    function getSiteNetworkServiceOutput(args: GetSiteNetworkServiceOutputArgs, opts?: InvokeOptions): Output<GetSiteNetworkServiceResult>
    def get_site_network_service(resource_group_name: Optional[str] = None,
                                 site_network_service_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetSiteNetworkServiceResult
    def get_site_network_service_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                 site_network_service_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetSiteNetworkServiceResult]
    func LookupSiteNetworkService(ctx *Context, args *LookupSiteNetworkServiceArgs, opts ...InvokeOption) (*LookupSiteNetworkServiceResult, error)
    func LookupSiteNetworkServiceOutput(ctx *Context, args *LookupSiteNetworkServiceOutputArgs, opts ...InvokeOption) LookupSiteNetworkServiceResultOutput

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

    public static class GetSiteNetworkService 
    {
        public static Task<GetSiteNetworkServiceResult> InvokeAsync(GetSiteNetworkServiceArgs args, InvokeOptions? opts = null)
        public static Output<GetSiteNetworkServiceResult> Invoke(GetSiteNetworkServiceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSiteNetworkServiceResult> getSiteNetworkService(GetSiteNetworkServiceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:hybridnetwork:getSiteNetworkService
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SiteNetworkServiceName string
    The name of the site network service.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SiteNetworkServiceName string
    The name of the site network service.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    siteNetworkServiceName String
    The name of the site network service.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    siteNetworkServiceName string
    The name of the site network service.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    site_network_service_name str
    The name of the site network service.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    siteNetworkServiceName String
    The name of the site network service.

    getSiteNetworkService Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.HybridNetwork.Outputs.SiteNetworkServicePropertiesFormatResponse
    Site network service properties.
    SystemData Pulumi.AzureNative.HybridNetwork.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"
    Identity Pulumi.AzureNative.HybridNetwork.Outputs.ManagedServiceIdentityResponse
    The managed identity of the Site network service, if configured.
    Sku Pulumi.AzureNative.HybridNetwork.Outputs.SkuResponse
    Sku of the site network service.
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties SiteNetworkServicePropertiesFormatResponse
    Site network service properties.
    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"
    Identity ManagedServiceIdentityResponse
    The managed identity of the Site network service, if configured.
    Sku SkuResponse
    Sku of the site network service.
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties SiteNetworkServicePropertiesFormatResponse
    Site network service properties.
    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"
    identity ManagedServiceIdentityResponse
    The managed identity of the Site network service, if configured.
    sku SkuResponse
    Sku of the site network service.
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties SiteNetworkServicePropertiesFormatResponse
    Site network service properties.
    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"
    identity ManagedServiceIdentityResponse
    The managed identity of the Site network service, if configured.
    sku SkuResponse
    Sku of the site network service.
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties SiteNetworkServicePropertiesFormatResponse
    Site network service properties.
    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"
    identity ManagedServiceIdentityResponse
    The managed identity of the Site network service, if configured.
    sku SkuResponse
    Sku of the site network service.
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    Site network service properties.
    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"
    identity Property Map
    The managed identity of the Site network service, if configured.
    sku Property Map
    Sku of the site network service.
    tags Map<String>
    Resource tags.

    Supporting Types

    ManagedResourceGroupConfigurationResponse

    Location string
    Managed resource group location.
    Name string
    Managed resource group name.
    Location string
    Managed resource group location.
    Name string
    Managed resource group name.
    location String
    Managed resource group location.
    name String
    Managed resource group name.
    location string
    Managed resource group location.
    name string
    Managed resource group name.
    location str
    Managed resource group location.
    name str
    Managed resource group name.
    location String
    Managed resource group location.
    name String
    Managed resource group name.

    ManagedServiceIdentityResponse

    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.HybridNetwork.Inputs.UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principal_id str
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<Property Map>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

    OpenDeploymentResourceReferenceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    ReferencedResourceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    SecretDeploymentResourceReferenceResponse

    SiteNetworkServicePropertiesFormatResponse

    LastStateConfigurationGroupValueReferences Dictionary<string, Pulumi.AzureNative.HybridNetwork.Inputs.ReferencedResourceResponse>
    The last state of the site network service resource.
    LastStateNetworkServiceDesignVersionName string
    The network service design version for the site network service.
    NetworkServiceDesignGroupName string
    The network service design group name for the site network service.
    NetworkServiceDesignVersionName string
    The network service design version for the site network service.
    NetworkServiceDesignVersionOfferingLocation string
    The location of the network service design offering.
    ProvisioningState string
    The provisioning state of the site network service resource.
    PublisherName string
    The publisher name for the site network service.
    PublisherScope string
    The scope of the publisher.
    DesiredStateConfigurationGroupValueReferences Dictionary<string, Pulumi.AzureNative.HybridNetwork.Inputs.ReferencedResourceResponse>
    The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
    ManagedResourceGroupConfiguration Pulumi.AzureNative.HybridNetwork.Inputs.ManagedResourceGroupConfigurationResponse
    Managed resource group configuration.
    NetworkServiceDesignVersionResourceReference Pulumi.AzureNative.HybridNetwork.Inputs.OpenDeploymentResourceReferenceResponse | Pulumi.AzureNative.HybridNetwork.Inputs.SecretDeploymentResourceReferenceResponse
    The network service design version resource reference.
    SiteReference Pulumi.AzureNative.HybridNetwork.Inputs.ReferencedResourceResponse
    The site details
    LastStateConfigurationGroupValueReferences map[string]ReferencedResourceResponse
    The last state of the site network service resource.
    LastStateNetworkServiceDesignVersionName string
    The network service design version for the site network service.
    NetworkServiceDesignGroupName string
    The network service design group name for the site network service.
    NetworkServiceDesignVersionName string
    The network service design version for the site network service.
    NetworkServiceDesignVersionOfferingLocation string
    The location of the network service design offering.
    ProvisioningState string
    The provisioning state of the site network service resource.
    PublisherName string
    The publisher name for the site network service.
    PublisherScope string
    The scope of the publisher.
    DesiredStateConfigurationGroupValueReferences map[string]ReferencedResourceResponse
    The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
    ManagedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse
    Managed resource group configuration.
    NetworkServiceDesignVersionResourceReference OpenDeploymentResourceReferenceResponse | SecretDeploymentResourceReferenceResponse
    The network service design version resource reference.
    SiteReference ReferencedResourceResponse
    The site details
    lastStateConfigurationGroupValueReferences Map<String,ReferencedResourceResponse>
    The last state of the site network service resource.
    lastStateNetworkServiceDesignVersionName String
    The network service design version for the site network service.
    networkServiceDesignGroupName String
    The network service design group name for the site network service.
    networkServiceDesignVersionName String
    The network service design version for the site network service.
    networkServiceDesignVersionOfferingLocation String
    The location of the network service design offering.
    provisioningState String
    The provisioning state of the site network service resource.
    publisherName String
    The publisher name for the site network service.
    publisherScope String
    The scope of the publisher.
    desiredStateConfigurationGroupValueReferences Map<String,ReferencedResourceResponse>
    The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
    managedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse
    Managed resource group configuration.
    networkServiceDesignVersionResourceReference OpenDeploymentResourceReferenceResponse | SecretDeploymentResourceReferenceResponse
    The network service design version resource reference.
    siteReference ReferencedResourceResponse
    The site details
    lastStateConfigurationGroupValueReferences {[key: string]: ReferencedResourceResponse}
    The last state of the site network service resource.
    lastStateNetworkServiceDesignVersionName string
    The network service design version for the site network service.
    networkServiceDesignGroupName string
    The network service design group name for the site network service.
    networkServiceDesignVersionName string
    The network service design version for the site network service.
    networkServiceDesignVersionOfferingLocation string
    The location of the network service design offering.
    provisioningState string
    The provisioning state of the site network service resource.
    publisherName string
    The publisher name for the site network service.
    publisherScope string
    The scope of the publisher.
    desiredStateConfigurationGroupValueReferences {[key: string]: ReferencedResourceResponse}
    The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
    managedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse
    Managed resource group configuration.
    networkServiceDesignVersionResourceReference OpenDeploymentResourceReferenceResponse | SecretDeploymentResourceReferenceResponse
    The network service design version resource reference.
    siteReference ReferencedResourceResponse
    The site details
    last_state_configuration_group_value_references Mapping[str, ReferencedResourceResponse]
    The last state of the site network service resource.
    last_state_network_service_design_version_name str
    The network service design version for the site network service.
    network_service_design_group_name str
    The network service design group name for the site network service.
    network_service_design_version_name str
    The network service design version for the site network service.
    network_service_design_version_offering_location str
    The location of the network service design offering.
    provisioning_state str
    The provisioning state of the site network service resource.
    publisher_name str
    The publisher name for the site network service.
    publisher_scope str
    The scope of the publisher.
    desired_state_configuration_group_value_references Mapping[str, ReferencedResourceResponse]
    The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
    managed_resource_group_configuration ManagedResourceGroupConfigurationResponse
    Managed resource group configuration.
    network_service_design_version_resource_reference OpenDeploymentResourceReferenceResponse | SecretDeploymentResourceReferenceResponse
    The network service design version resource reference.
    site_reference ReferencedResourceResponse
    The site details
    lastStateConfigurationGroupValueReferences Map<Property Map>
    The last state of the site network service resource.
    lastStateNetworkServiceDesignVersionName String
    The network service design version for the site network service.
    networkServiceDesignGroupName String
    The network service design group name for the site network service.
    networkServiceDesignVersionName String
    The network service design version for the site network service.
    networkServiceDesignVersionOfferingLocation String
    The location of the network service design offering.
    provisioningState String
    The provisioning state of the site network service resource.
    publisherName String
    The publisher name for the site network service.
    publisherScope String
    The scope of the publisher.
    desiredStateConfigurationGroupValueReferences Map<Property Map>
    The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
    managedResourceGroupConfiguration Property Map
    Managed resource group configuration.
    networkServiceDesignVersionResourceReference Property Map | Property Map
    The network service design version resource reference.
    siteReference Property Map
    The site details

    SkuResponse

    Name string
    Name of this Sku
    Tier string
    The SKU tier based on the SKU name.
    Name string
    Name of this Sku
    Tier string
    The SKU tier based on the SKU name.
    name String
    Name of this Sku
    tier String
    The SKU tier based on the SKU name.
    name string
    Name of this Sku
    tier string
    The SKU tier based on the SKU name.
    name str
    Name of this Sku
    tier str
    The SKU tier based on the SKU name.
    name String
    Name of this Sku
    tier String
    The SKU tier based on the SKU name.

    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.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi