{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Domains API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Domains", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Check If A Domain Is Available For Registration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.DomainRegistration/checkDomainAvailability", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Check if a domain is available for registration." }, { "info": { "name": "Microsoft Azure Get All Domains In A Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.DomainRegistration/domains", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Get all domains in a subscription." }, { "info": { "name": "Microsoft Azure Generate A Single Sign On Request For The Domain Management Portal", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.DomainRegistration/generateSsoRequest", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Generate a single sign-on request for the domain management portal." }, { "info": { "name": "Microsoft Azure Get Domain Name Recommendations Based On Keywords", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.DomainRegistration/listDomainRecommendations", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Get domain name recommendations based on keywords." }, { "info": { "name": "Microsoft Azure Get All Domains In A Resource Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Get all domains in a resource group." }, { "info": { "name": "Microsoft Azure Get A Domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Get a domain." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Domain", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Creates or updates a domain." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Domain", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Creates or updates a domain." }, { "info": { "name": "Microsoft Azure Delete A Domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "forceHardDeleteDomain", "value": "", "type": "query", "description": "Specify true to delete the domain immediately. The default is false which deletes the domain after 24 hours." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Delete a domain." }, { "info": { "name": "Microsoft Azure Lists Domain Ownership Identifiers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/domainOwnershipIdentifiers", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of domain." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Lists domain ownership identifiers." }, { "info": { "name": "Microsoft Azure Get Ownership Identifier For Domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/domainOwnershipIdentifiers/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of domain." }, { "name": "name", "value": "", "type": "path", "description": "Name of identifier." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Get ownership identifier for domain" }, { "info": { "name": "Microsoft Azure Creates An Ownership Identifier For A Domain Or Updates Identifier Details For An Existing Identifier", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/domainOwnershipIdentifiers/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of domain." }, { "name": "name", "value": "", "type": "path", "description": "Name of identifier." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier" }, { "info": { "name": "Microsoft Azure Creates An Ownership Identifier For A Domain Or Updates Identifier Details For An Existing Identifier", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/domainOwnershipIdentifiers/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of domain." }, { "name": "name", "value": "", "type": "path", "description": "Name of identifier." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier" }, { "info": { "name": "Microsoft Azure Delete Ownership Identifier For Domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/domainOwnershipIdentifiers/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of domain." }, { "name": "name", "value": "", "type": "path", "description": "Name of identifier." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Delete ownership identifier for domain" }, { "info": { "name": "Microsoft Azure Renew A Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/renew", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Renew a domain." }, { "info": { "name": "Microsoft Azure Transfer Out Domain To Another Registrar", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/transferOut", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of domain." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get A Domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/domains/:domainName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Get properties of a domain." }, { "info": { "name": "Microsoft Azure Create Or Update A Domain", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/domains/:domainName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Asynchronously creates or updates a new domain with the specified parameters." }, { "info": { "name": "Microsoft Azure Update A Domain", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/domains/:domainName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Asynchronously updates a domain with the specified parameters." }, { "info": { "name": "Microsoft Azure Delete A Domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/domains/:domainName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Delete existing domain." }, { "info": { "name": "Microsoft Azure List Domains Under An Azure Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.EventGrid/domains", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." }, { "name": "$filter", "value": "", "type": "query", "description": "The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'." }, { "name": "$top", "value": "", "type": "query", "description": "The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page." } ] }, "docs": "List all the domains under an Azure subscription." }, { "info": { "name": "Microsoft Azure List Domains Under A Resource Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/domains", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." }, { "name": "$filter", "value": "", "type": "query", "description": "The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'." }, { "name": "$top", "value": "", "type": "query", "description": "The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page." } ] }, "docs": "List all the domains under a resource group." }, { "info": { "name": "Microsoft Azure List Keys For A Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/domains/:domainName/listKeys", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "List the two keys used to publish to a domain." }, { "info": { "name": "Microsoft Azure Regenerate Key For A Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/domains/:domainName/regenerateKey", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Regenerate a shared access key for a domain." }, { "info": { "name": "Microsoft Azure Retrieves The Latest Status Of A Domain Purchase Operation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DomainRegistration/domains/:domainName/operationresults/:operationId", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group" }, { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain" }, { "name": "operationId", "value": "", "type": "path", "description": "Domain purchase operation Id" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription Id" }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Needs a more full description created." } ] } ], "bundled": true }