openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 19 kB
JSON
{"openapi":"3.0.0","info":{"description":"The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.","title":"NetworkManagementClient","version":"2019-07-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/publicIpPrefix.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-publicIpPrefix","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPPrefixes":{"get":{"description":"Gets all the public IP prefixes in a subscription.","operationId":"PublicIPPrefixes_ListAll","parameters":[{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all public IP prefixes":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all public IP prefixes":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of PublicIPPrefix resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIPPrefixListResult"},"examples":{"List all public IP prefixes":{"$ref":"#/components/examples/List_all_public_IP_prefixes"}}}}}},"tags":["PublicIPPrefixes"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes":{"get":{"description":"Gets all public IP prefixes in a resource group.","operationId":"PublicIPPrefixes_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List resource group public IP prefixes":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List resource group public IP prefixes":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List resource group public IP prefixes":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of PublicIPPrefix resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIPPrefixListResult"},"examples":{"List resource group public IP prefixes":{"$ref":"#/components/examples/List_resource_group_public_IP_prefixes"}}}}}},"tags":["PublicIPPrefixes"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}":{"delete":{"description":"Deletes the specified public IP prefix.","operationId":"PublicIPPrefixes_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete public IP prefix":{"value":"rg1"}}},{"description":"The name of the PublicIpPrefix.","in":"path","name":"publicIpPrefixName","required":true,"schema":{"type":"string"},"examples":{"Delete public IP prefix":{"value":"test-ipprefix"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete public IP prefix":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete public IP prefix":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Request successful. Resource does not exist."}},"tags":["PublicIPPrefixes"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified public IP prefix in a specified resource group.","operationId":"PublicIPPrefixes_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get public IP prefix":{"value":"rg1"}}},{"description":"The name of the public IP prefix.","in":"path","name":"publicIpPrefixName","required":true,"schema":{"type":"string"},"examples":{"Get public IP prefix":{"value":"test-ipprefix"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get public IP prefix":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get public IP prefix":{"value":"subid"}}},{"description":"Expands referenced resources.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful. The operation returns the resulting PublicIPPrefix resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIPPrefix"},"examples":{"Get public IP prefix":{"$ref":"#/components/examples/Get_public_IP_prefix"}}}}}},"tags":["PublicIPPrefixes"]},"patch":{"description":"Updates public IP prefix tags.","operationId":"PublicIPPrefixes_UpdateTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Update public IP prefix tags":{"value":"rg1"}}},{"description":"The name of the public IP prefix.","in":"path","name":"publicIpPrefixName","required":true,"schema":{"type":"string"},"examples":{"Update public IP prefix tags":{"value":"test-ipprefix"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update public IP prefix tags":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Update public IP prefix tags":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Tags object for patch operations.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}}}}},"description":"Parameters supplied to update public IP prefix tags.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting PublicIPPrefix resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIPPrefix"},"examples":{"Update public IP prefix tags":{"$ref":"#/components/examples/Update_public_IP_prefix_tags"}}}}}},"tags":["PublicIPPrefixes"],"x-ms-long-running-operation":true},"put":{"description":"Creates or updates a static or dynamic public IP prefix.","operationId":"PublicIPPrefixes_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create public IP prefix allocation method":{"value":"rg1"},"Create public IP prefix defaults":{"value":"rg1"}}},{"description":"The name of the public IP prefix.","in":"path","name":"publicIpPrefixName","required":true,"schema":{"type":"string"},"examples":{"Create public IP prefix allocation method":{"value":"test-ipprefix"},"Create public IP prefix defaults":{"value":"test-ipprefix"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create public IP prefix allocation method":{"value":"2019-07-01"},"Create public IP prefix defaults":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create public IP prefix allocation method":{"value":"subid"},"Create public IP prefix defaults":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIPPrefix"}}},"description":"Parameters supplied to the create or update public IP prefix operation.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting PublicIPPrefix resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIPPrefix"},"examples":{"Create public IP prefix allocation method":{"$ref":"#/components/examples/Create_public_IP_prefix_allocation_method"},"Create public IP prefix defaults":{"$ref":"#/components/examples/Create_public_IP_prefix_defaults"}}}}},"201":{"description":"Create successful. The operation returns the resulting PublicIPPrefix resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicIPPrefix"},"examples":{"Create public IP prefix allocation method":{"$ref":"#/components/examples/Create_public_IP_prefix_allocation_method"},"Create public IP prefix defaults":{"$ref":"#/components/examples/Create_public_IP_prefix_defaults"}}}}}},"tags":["PublicIPPrefixes"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_all_public_IP_prefixes":{"value":{"value":[{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix","location":"westus","name":"test-ipprefix","properties":{"ipPrefix":"41.85.154.247/30","ipTags":[],"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","publicIPAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes"},{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/ipprefix01","location":"westus","name":"ipprefix01","properties":{"ipPrefix":"40.85.154.247/30","ipTags":[],"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes"},{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/publicIPPrefixes/pfx","location":"westus","name":"pfx","properties":{"ipPrefix":"25.101.84.16/30","ipTags":[],"loadBalancerFrontendIpConfiguration":{"id":"/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/loadBalancers/lb-pfx/frontendIPConfigurations/ipconfig1"},"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes"}]}},"List_resource_group_public_IP_prefixes":{"value":{"value":[{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix","location":"westus","name":"test-ipprefix","properties":{"ipPrefix":"40.85.154.2/30","ipTags":[{"ipTagType":"FirstPartyUsage","tag":"SQL"}],"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes"},{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03","location":"westus","name":"ipprefix03","properties":{"ipPrefix":"40.85.153.2/31","ipTags":[],"prefixLength":31,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes"}]}},"Get_public_IP_prefix":{"value":{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix","location":"westus","name":"test-ipprefix","properties":{"ipPrefix":"192.168.254.2/30","ipTags":[],"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","publicIPAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes"}},"Update_public_IP_prefix_tags":{"value":{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix","location":"westus","name":"test-ipprefix","properties":{"ipPrefix":"40.85.154.247/30","ipTags":[],"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"tags":{"tag1":"value1","tag2":"value2"},"type":"Microsoft.Network/publicIPPrefixes"}},"Create_public_IP_prefix_allocation_method":{"value":{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix","location":"westus","name":"test-ipprefix","properties":{"ipPrefix":"192.168.254.2/30","ipTags":[],"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes","zones":["1"]}},"Create_public_IP_prefix_defaults":{"value":{"etag":"W/\"00000000-0000-0000-0000-00000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix","location":"westus","name":"test-ipprefix","properties":{"ipPrefix":"192.168.254.2/30","ipTags":[],"prefixLength":30,"provisioningState":"Succeeded","publicIPAddressVersion":"IPv4","resourceGuid":"00000000-0000-0000-0000-00000000"},"sku":{"name":"Standard"},"type":"Microsoft.Network/publicIPPrefixes"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"PublicIPPrefix":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Public IP prefix resource.","properties":{"etag":{"description":"A unique read-only string that changes whenever the resource is updated.","type":"string"},"properties":{"$ref":"#/components/schemas/PublicIPPrefixPropertiesFormat"},"sku":{"$ref":"#/components/schemas/PublicIPPrefixSku"},"zones":{"description":"A list of availability zones denoting the IP allocated for the resource needs to come from.","items":{"type":"string"},"type":"array"}}},"PublicIPPrefixListResult":{"description":"Response for ListPublicIpPrefixes API service call.","properties":{"nextLink":{"description":"The URL to get the next set of results.","type":"string"},"value":{"description":"A list of public IP prefixes that exists in a resource group.","items":{"$ref":"#/components/schemas/PublicIPPrefix"},"type":"array"}}},"PublicIPPrefixPropertiesFormat":{"description":"Public IP prefix properties.","properties":{"ipPrefix":{"description":"The allocated Prefix.","type":"string"},"ipTags":{"description":"The list of tags associated with the public IP prefix.","items":{"description":"Contains the IpTag associated with the object.","properties":{"ipTagType":{"description":"The IP tag type. Example: FirstPartyUsage.","type":"string"},"tag":{"description":"The value of the IP tag associated with the public IP. Example: SQL.","type":"string"}}},"type":"array"},"loadBalancerFrontendIpConfiguration":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"prefixLength":{"description":"The Length of the Public IP Prefix.","format":"int32","type":"integer"},"provisioningState":{"description":"The current provisioning state.","enum":["Succeeded","Updating","Deleting","Failed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"publicIPAddressVersion":{"description":"IP address version.","enum":["IPv4","IPv6"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IPVersion"}},"publicIPAddresses":{"description":"The list of all referenced PublicIPAddresses.","items":{"$ref":"#/components/schemas/ReferencedPublicIpAddress"},"type":"array"},"resourceGuid":{"description":"The resource GUID property of the public IP prefix resource.","type":"string"}}},"PublicIPPrefixSku":{"description":"SKU of a public IP prefix.","properties":{"name":{"description":"Name of a public IP prefix SKU.","enum":["Standard"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PublicIPPrefixSkuName"}}}},"ReferencedPublicIpAddress":{"description":"Reference to a public IP address.","properties":{"id":{"description":"The PublicIPAddress Reference.","type":"string"}}}}}}