Microsoft Azure PublicIpAddresses API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PublicIpAddresses API
schemes:
- https
tags:
- name: PublicIpAddresses
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}/
  : delete:
      tags:
      - PublicIpAddresses
      operationId: microsoftAzurePublicipaddressesDelete
      description: The delete publicIpAddress operation deletes the specified publicIpAddress.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: publicIpAddressName
        in: path
        required: true
        type: string
        description: The name of the subnet.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
        '202':
          description: ''
        '204':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Publicipaddresses Publicipaddressname
    get:
      tags:
      - PublicIpAddresses
      operationId: microsoftAzurePublicipaddressesGet
      description: The Get publicIpAddress operation retrieves information about the specified pubicIpAddress
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: publicIpAddressName
        in: path
        required: true
        type: string
        description: The name of the subnet.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/PublicIpAddress'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Publicipaddresses Publicipaddressname
    put:
      tags:
      - PublicIpAddresses
      operationId: microsoftAzurePublicipaddressesCreateorupdate
      description: The Put PublicIPAddress operation creates/updates a stable/dynamic PublicIP address
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: publicIpAddressName
        in: path
        required: true
        type: string
        description: The name of the publicIpAddress.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/PublicIpAddress'
        description: Parameters supplied to the create/update PublicIPAddress operation
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/PublicIpAddress'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/PublicIpAddress'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Publicipaddresses Publicipaddressname
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses:
    get:
      tags:
      - PublicIpAddresses
      operationId: microsoftAzurePublicipaddressesListall
      description: The List publicIpAddress operation retrieves all the publicIpAddresses in a subscription.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/PublicIpAddressListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Publicipaddresses
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses:
    get:
      tags:
      - PublicIpAddresses
      operationId: microsoftAzurePublicipaddressesList
      description: The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/PublicIpAddressListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Publicipaddresses
definitions:
  Resource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      location:
        type: string
        description: Resource location
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
  SubResource:
    properties:
      id:
        type: string
        description: Resource Id
    x-ms-azure-resource: true
  PublicIpAddressListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/PublicIpAddress'
        description: Gets List of publicIP addresses that exists in a resource group
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListPublicIpAddresses Api service call
  PublicIpAddressDnsSettings:
    properties:
      domainNameLabel:
        type: string
        description: Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
      fqdn:
        type: string
        description: Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.
      reverseFqdn:
        type: string
        description: 'Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. '
    description: Contains FQDN of the DNS record associated with the public IP address
  PublicIpAddress:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/PublicIpAddressPropertiesFormat'
      etag:
        type: string
        description: Gets a unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/Resource'
    description: PublicIPAddress resource
  PublicIpAddressPropertiesFormat:
    properties:
      publicIPAllocationMethod:
        type: string
        description: Gets or sets PublicIP allocation method (Static/Dynamic)
        enum:
        - Static
        - Dynamic
        x-ms-enum:
          name: IpAllocationMethod
          modelAsString: true
      ipConfiguration:
        $ref: '#/definitions/SubResource'
        description: Gets a reference to the network interface IP configurations using this public IP address
      dnsSettings:
        $ref: '#/definitions/PublicIpAddressDnsSettings'
        description: Gets or sets FQDN of the DNS record associated with the public IP address
      ipAddress:
        type: string
        description: Gets the assigned public IP address
      idleTimeoutInMinutes:
        type: integer
        format: int32
        description: Gets or sets the idle timeout of the public IP address
      resourceGuid:
        type: string
        description: Gets or sets resource guid property of the PublicIP resource
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    required:
    - publicIPAllocationMethod
    description: PublicIpAddress properties
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'