1. Packages
  2. Azure Native v2
  3. API Docs
  4. edgeorder
  5. getAddressByName
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

azure-native-v2.edgeorder.getAddressByName

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

Gets information about the specified address. Azure REST API version: 2021-12-01.

Using getAddressByName

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 getAddressByName(args: GetAddressByNameArgs, opts?: InvokeOptions): Promise<GetAddressByNameResult>
function getAddressByNameOutput(args: GetAddressByNameOutputArgs, opts?: InvokeOptions): Output<GetAddressByNameResult>
Copy
def get_address_by_name(address_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetAddressByNameResult
def get_address_by_name_output(address_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetAddressByNameResult]
Copy
func LookupAddressByName(ctx *Context, args *LookupAddressByNameArgs, opts ...InvokeOption) (*LookupAddressByNameResult, error)
func LookupAddressByNameOutput(ctx *Context, args *LookupAddressByNameOutputArgs, opts ...InvokeOption) LookupAddressByNameResultOutput
Copy

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

public static class GetAddressByName 
{
    public static Task<GetAddressByNameResult> InvokeAsync(GetAddressByNameArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressByNameResult> Invoke(GetAddressByNameInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAddressByNameResult> getAddressByName(GetAddressByNameArgs args, InvokeOptions options)
public static Output<GetAddressByNameResult> getAddressByName(GetAddressByNameArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:edgeorder:getAddressByName
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AddressName
This property is required.
Changes to this property will trigger replacement.
string
The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AddressName
This property is required.
Changes to this property will trigger replacement.
string
The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
addressName
This property is required.
Changes to this property will trigger replacement.
String
The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
addressName
This property is required.
Changes to this property will trigger replacement.
string
The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
address_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
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.
addressName
This property is required.
Changes to this property will trigger replacement.
String
The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getAddressByName Result

The following output properties are available:

AddressValidationStatus string
Status of address validation
ContactDetails Pulumi.AzureNative.EdgeOrder.Outputs.ContactDetailsResponse
Contact details for the address
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
SystemData Pulumi.AzureNative.EdgeOrder.Outputs.SystemDataResponse
Represents resource creation and update time
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ShippingAddress Pulumi.AzureNative.EdgeOrder.Outputs.ShippingAddressResponse
Shipping details for the address
Tags Dictionary<string, string>
Resource tags.
AddressValidationStatus string
Status of address validation
ContactDetails ContactDetailsResponse
Contact details for the address
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
SystemData SystemDataResponse
Represents resource creation and update time
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ShippingAddress ShippingAddressResponse
Shipping details for the address
Tags map[string]string
Resource tags.
addressValidationStatus String
Status of address validation
contactDetails ContactDetailsResponse
Contact details for the address
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
systemData SystemDataResponse
Represents resource creation and update time
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
shippingAddress ShippingAddressResponse
Shipping details for the address
tags Map<String,String>
Resource tags.
addressValidationStatus string
Status of address validation
contactDetails ContactDetailsResponse
Contact details for the address
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
systemData SystemDataResponse
Represents resource creation and update time
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
shippingAddress ShippingAddressResponse
Shipping details for the address
tags {[key: string]: string}
Resource tags.
address_validation_status str
Status of address validation
contact_details ContactDetailsResponse
Contact details for the address
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
system_data SystemDataResponse
Represents resource creation and update time
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
shipping_address ShippingAddressResponse
Shipping details for the address
tags Mapping[str, str]
Resource tags.
addressValidationStatus String
Status of address validation
contactDetails Property Map
Contact details for the address
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
systemData Property Map
Represents resource creation and update time
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
shippingAddress Property Map
Shipping details for the address
tags Map<String>
Resource tags.

Supporting Types

ContactDetailsResponse

ContactName This property is required. string
Contact name of the person.
EmailList This property is required. List<string>
List of Email-ids to be notified about job progress.
Phone This property is required. string
Phone number of the contact person.
Mobile string
Mobile number of the contact person.
PhoneExtension string
Phone extension number of the contact person.
ContactName This property is required. string
Contact name of the person.
EmailList This property is required. []string
List of Email-ids to be notified about job progress.
Phone This property is required. string
Phone number of the contact person.
Mobile string
Mobile number of the contact person.
PhoneExtension string
Phone extension number of the contact person.
contactName This property is required. String
Contact name of the person.
emailList This property is required. List<String>
List of Email-ids to be notified about job progress.
phone This property is required. String
Phone number of the contact person.
mobile String
Mobile number of the contact person.
phoneExtension String
Phone extension number of the contact person.
contactName This property is required. string
Contact name of the person.
emailList This property is required. string[]
List of Email-ids to be notified about job progress.
phone This property is required. string
Phone number of the contact person.
mobile string
Mobile number of the contact person.
phoneExtension string
Phone extension number of the contact person.
contact_name This property is required. str
Contact name of the person.
email_list This property is required. Sequence[str]
List of Email-ids to be notified about job progress.
phone This property is required. str
Phone number of the contact person.
mobile str
Mobile number of the contact person.
phone_extension str
Phone extension number of the contact person.
contactName This property is required. String
Contact name of the person.
emailList This property is required. List<String>
List of Email-ids to be notified about job progress.
phone This property is required. String
Phone number of the contact person.
mobile String
Mobile number of the contact person.
phoneExtension String
Phone extension number of the contact person.

ShippingAddressResponse

Country This property is required. string
Name of the Country.
StreetAddress1 This property is required. string
Street Address line 1.
AddressType string
Type of address.
City string
Name of the City.
CompanyName string
Name of the company.
PostalCode string
Postal code.
StateOrProvince string
Name of the State or Province.
StreetAddress2 string
Street Address line 2.
StreetAddress3 string
Street Address line 3.
ZipExtendedCode string
Extended Zip Code.
Country This property is required. string
Name of the Country.
StreetAddress1 This property is required. string
Street Address line 1.
AddressType string
Type of address.
City string
Name of the City.
CompanyName string
Name of the company.
PostalCode string
Postal code.
StateOrProvince string
Name of the State or Province.
StreetAddress2 string
Street Address line 2.
StreetAddress3 string
Street Address line 3.
ZipExtendedCode string
Extended Zip Code.
country This property is required. String
Name of the Country.
streetAddress1 This property is required. String
Street Address line 1.
addressType String
Type of address.
city String
Name of the City.
companyName String
Name of the company.
postalCode String
Postal code.
stateOrProvince String
Name of the State or Province.
streetAddress2 String
Street Address line 2.
streetAddress3 String
Street Address line 3.
zipExtendedCode String
Extended Zip Code.
country This property is required. string
Name of the Country.
streetAddress1 This property is required. string
Street Address line 1.
addressType string
Type of address.
city string
Name of the City.
companyName string
Name of the company.
postalCode string
Postal code.
stateOrProvince string
Name of the State or Province.
streetAddress2 string
Street Address line 2.
streetAddress3 string
Street Address line 3.
zipExtendedCode string
Extended Zip Code.
country This property is required. str
Name of the Country.
street_address1 This property is required. str
Street Address line 1.
address_type str
Type of address.
city str
Name of the City.
company_name str
Name of the company.
postal_code str
Postal code.
state_or_province str
Name of the State or Province.
street_address2 str
Street Address line 2.
street_address3 str
Street Address line 3.
zip_extended_code str
Extended Zip Code.
country This property is required. String
Name of the Country.
streetAddress1 This property is required. String
Street Address line 1.
addressType String
Type of address.
city String
Name of the City.
companyName String
Name of the company.
postalCode String
Postal code.
stateOrProvince String
Name of the State or Province.
streetAddress2 String
Street Address line 2.
streetAddress3 String
Street Address line 3.
zipExtendedCode String
Extended Zip Code.

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