ApiPortalCustomDomains interface
Interface representing a ApiPortalCustomDomains.
Methods
| begin |
Create or update the API portal custom domain. |
| begin |
Create or update the API portal custom domain. |
| begin |
Delete the API portal custom domain. |
| begin |
Delete the API portal custom domain. |
| get(string, string, string, string, Api |
Get the API portal custom domain. |
| list(string, string, string, Api |
Handle requests to list all API portal custom domains. |
Method Details
beginCreateOrUpdate(string, string, string, string, ApiPortalCustomDomainResource, ApiPortalCustomDomainsCreateOrUpdateOptionalParams)
Create or update the API portal custom domain.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, apiPortalCustomDomainResource: ApiPortalCustomDomainResource, options?: ApiPortalCustomDomainsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalCustomDomainResource>, ApiPortalCustomDomainResource>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName
-
string
The name of the Service resource.
- apiPortalName
-
string
The name of API portal.
- domainName
-
string
The name of the API portal custom domain.
- apiPortalCustomDomainResource
- ApiPortalCustomDomainResource
The API portal custom domain for the create or update operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalCustomDomainResource>, ApiPortalCustomDomainResource>>
beginCreateOrUpdateAndWait(string, string, string, string, ApiPortalCustomDomainResource, ApiPortalCustomDomainsCreateOrUpdateOptionalParams)
Create or update the API portal custom domain.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, apiPortalCustomDomainResource: ApiPortalCustomDomainResource, options?: ApiPortalCustomDomainsCreateOrUpdateOptionalParams): Promise<ApiPortalCustomDomainResource>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName
-
string
The name of the Service resource.
- apiPortalName
-
string
The name of API portal.
- domainName
-
string
The name of the API portal custom domain.
- apiPortalCustomDomainResource
- ApiPortalCustomDomainResource
The API portal custom domain for the create or update operation
The options parameters.
Returns
Promise<ApiPortalCustomDomainResource>
beginDelete(string, string, string, string, ApiPortalCustomDomainsDeleteOptionalParams)
Delete the API portal custom domain.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, options?: ApiPortalCustomDomainsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName
-
string
The name of the Service resource.
- apiPortalName
-
string
The name of API portal.
- domainName
-
string
The name of the API portal custom domain.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, ApiPortalCustomDomainsDeleteOptionalParams)
Delete the API portal custom domain.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, options?: ApiPortalCustomDomainsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName
-
string
The name of the Service resource.
- apiPortalName
-
string
The name of API portal.
- domainName
-
string
The name of the API portal custom domain.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ApiPortalCustomDomainsGetOptionalParams)
Get the API portal custom domain.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, options?: ApiPortalCustomDomainsGetOptionalParams): Promise<ApiPortalCustomDomainResource>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName
-
string
The name of the Service resource.
- apiPortalName
-
string
The name of API portal.
- domainName
-
string
The name of the API portal custom domain.
The options parameters.
Returns
Promise<ApiPortalCustomDomainResource>
list(string, string, string, ApiPortalCustomDomainsListOptionalParams)
Handle requests to list all API portal custom domains.
function list(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalCustomDomainsListOptionalParams): PagedAsyncIterableIterator<ApiPortalCustomDomainResource, ApiPortalCustomDomainResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName
-
string
The name of the Service resource.
- apiPortalName
-
string
The name of API portal.
The options parameters.