Class DnsClient
Service client instance for Dns.
Implements
Inherited Members
Namespace: Oci.DnsService
Assembly: OCI.DotNetSDK.Dns.dll
Syntax
public class DnsClient : RegionalClientBase, IDisposable
Constructors
DnsClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public DnsClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public DnsPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DnsPaginators |
Waiters
Declaration
public DnsWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DnsWaiters |
Methods
ChangeResolverCompartment(ChangeResolverCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a resolver into a different compartment along with its protected default view and any endpoints. <br/> Zones in the default view are not moved. VCN-dedicated resolvers are initially created in the same compartment as their corresponding VCN, but can then be moved to a different compartment.
Declaration
public Task<ChangeResolverCompartmentResponse> ChangeResolverCompartment(ChangeResolverCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeResolverCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeResolverCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeResolverCompartment API.
ChangeSteeringPolicyCompartment(ChangeSteeringPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a steering policy into a different compartment.
Declaration
public Task<ChangeSteeringPolicyCompartmentResponse> ChangeSteeringPolicyCompartment(ChangeSteeringPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSteeringPolicyCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeSteeringPolicyCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSteeringPolicyCompartment API.
ChangeTsigKeyCompartment(ChangeTsigKeyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a TSIG key into a different compartment.
Declaration
public Task<ChangeTsigKeyCompartmentResponse> ChangeTsigKeyCompartment(ChangeTsigKeyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeTsigKeyCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeTsigKeyCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeTsigKeyCompartment API.
ChangeViewCompartment(ChangeViewCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a view into a different compartment. <br/> To change the compartment of a protected view, change the compartment of its corresponding resolver.
Declaration
public Task<ChangeViewCompartmentResponse> ChangeViewCompartment(ChangeViewCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeViewCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeViewCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeViewCompartment API.
ChangeZoneCompartment(ChangeZoneCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a zone into a different compartment.
<br/>
Protected zones cannot have their compartment changed. When the zone name is provided as a path
parameter and PRIVATE
is used for the scope query parameter then the viewId query parameter is
required.
<br/>
Note: All SteeringPolicyAttachment objects associated with this zone will also be moved into
the provided compartment.
Declaration
public Task<ChangeZoneCompartmentResponse> ChangeZoneCompartment(ChangeZoneCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeZoneCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeZoneCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeZoneCompartment API.
CreateResolverEndpoint(CreateResolverEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new resolver endpoint in the same compartment as the resolver.
Declaration
public Task<CreateResolverEndpointResponse> CreateResolverEndpoint(CreateResolverEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateResolverEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateResolverEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateResolverEndpoint API.
CreateSteeringPolicy(CreateSteeringPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see Traffic Management API Guide.
Declaration
public Task<CreateSteeringPolicyResponse> CreateSteeringPolicy(CreateSteeringPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSteeringPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSteeringPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSteeringPolicy API.
CreateSteeringPolicyAttachment(CreateSteeringPolicyAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain. <br/> For the purposes of access control, the attachment is automatically placed into the same compartment as the domain's zone.
Declaration
public Task<CreateSteeringPolicyAttachmentResponse> CreateSteeringPolicyAttachment(CreateSteeringPolicyAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSteeringPolicyAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSteeringPolicyAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSteeringPolicyAttachment API.
CreateTsigKey(CreateTsigKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new TSIG key in the specified compartment. There is no
opc-retry-token
header since TSIG key names must be globally unique.
Declaration
public Task<CreateTsigKeyResponse> CreateTsigKey(CreateTsigKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTsigKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTsigKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTsigKey API.
CreateView(CreateViewRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new view in the specified compartment.
Declaration
public Task<CreateViewResponse> CreateView(CreateViewRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateViewRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateViewResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateView API.
CreateZone(CreateZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new zone in the specified compartment.
<br/>
Private zones must have a zone type of PRIMARY
. Creating a private zone at or under oraclevcn.com
within the default protected view of a VCN-dedicated resolver is not permitted.
Declaration
public Task<CreateZoneResponse> CreateZone(CreateZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateZoneRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateZone API.
CreateZoneFromZoneFile(CreateZoneFromZoneFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new zone from a zone file in the specified compartment. Not supported for private zones.
Declaration
public Task<CreateZoneFromZoneFileResponse> CreateZoneFromZoneFile(CreateZoneFromZoneFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateZoneFromZoneFileRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateZoneFromZoneFileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateZoneFromZoneFile API.
DeleteDomainRecords(DeleteDomainRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes all records at the specified zone and domain.
<br/>
When the zone name is provided as a path parameter and PRIVATE
is used for the scope query parameter
then the viewId query parameter is required.
Declaration
public Task<DeleteDomainRecordsResponse> DeleteDomainRecords(DeleteDomainRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDomainRecordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDomainRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDomainRecords API.
DeleteRRSet(DeleteRRSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes all records in the specified RRSet.
<br/>
When the zone name is provided as a path parameter and PRIVATE
is used for the scope
query parameter then the viewId query parameter is required.
Declaration
public Task<DeleteRRSetResponse> DeleteRRSet(DeleteRRSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRRSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteRRSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRRSet API.
DeleteResolverEndpoint(DeleteResolverEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified resolver endpoint.
<br/>
Note that attempting to delete a resolver endpoint in the DELETED lifecycle state will result in
a 404
response to be consistent with other operations of the API. Resolver endpoints may not
be deleted if they are referenced by a resolver rule.
Declaration
public Task<DeleteResolverEndpointResponse> DeleteResolverEndpoint(DeleteResolverEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteResolverEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteResolverEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteResolverEndpoint API.
DeleteSteeringPolicy(DeleteSteeringPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified steering policy.
<br/>
A 204
response indicates that the delete has been successful.
Deletion will fail if the policy is attached to any zones. To detach a
policy from a zone, see DeleteSteeringPolicyAttachment
.
Declaration
public Task<DeleteSteeringPolicyResponse> DeleteSteeringPolicy(DeleteSteeringPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSteeringPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSteeringPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSteeringPolicy API.
DeleteSteeringPolicyAttachment(DeleteSteeringPolicyAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified steering policy attachment.
A 204
response indicates that the delete has been successful.
Declaration
public Task<DeleteSteeringPolicyAttachmentResponse> DeleteSteeringPolicyAttachment(DeleteSteeringPolicyAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSteeringPolicyAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSteeringPolicyAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSteeringPolicyAttachment API.
DeleteTsigKey(DeleteTsigKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified TSIG key.
Declaration
public Task<DeleteTsigKeyResponse> DeleteTsigKey(DeleteTsigKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTsigKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTsigKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTsigKey API.
DeleteView(DeleteViewRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified view.
<br/>
Note that attempting to delete a view in the DELETED lifecycleState will result in a 404
response to be consistent with other operations of the API. Views cannot be
deleted if they are referenced by non-deleted zones or resolvers.
Protected views cannot be deleted.
Declaration
public Task<DeleteViewResponse> DeleteView(DeleteViewRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteViewRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteViewResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteView API.
DeleteZone(DeleteZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified zone and all its steering policy attachments.
<br/>
A 204
response indicates that the zone has been successfully deleted. Protected zones cannot be deleted.
When the zone name is provided as a path parameter and PRIVATE
is used for the scope query parameter
then the viewId query parameter is required.
Declaration
public Task<DeleteZoneResponse> DeleteZone(DeleteZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteZoneRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteZone API.
GetDomainRecords(GetDomainRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all records at the specified zone and domain.
<br/>
The results are sorted by rtype
in alphabetical order by default. You can optionally filter and/or sort
the results using the listed parameters. When the zone name is provided as a path parameter and PRIVATE
is used for the scope query parameter then the viewId query parameter is required.
Declaration
public Task<GetDomainRecordsResponse> GetDomainRecords(GetDomainRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDomainRecordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDomainRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDomainRecords API.
GetRRSet(GetRRSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all records in the specified RRSet.
<br/>
The results are sorted by recordHash
by default. When the zone name is provided as a path parameter
and PRIVATE
is used for the scope query parameter then the viewId query parameter is required.
Declaration
public Task<GetRRSetResponse> GetRRSet(GetRRSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRRSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRRSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRRSet API.
GetResolver(GetResolverRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about a specific resolver.
<br/>
Note that attempting to get a resolver in the DELETED lifecycleState will result in a 404
response to be consistent with other operations of the API.
Declaration
public Task<GetResolverResponse> GetResolver(GetResolverRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResolverRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetResolverResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResolver API.
GetResolverEndpoint(GetResolverEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about a specific resolver endpoint.
<br/>
Note that attempting to get a resolver endpoint in the DELETED lifecycle state will result
in a 404
response to be consistent with other operations of the API.
Declaration
public Task<GetResolverEndpointResponse> GetResolverEndpoint(GetResolverEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResolverEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetResolverEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResolverEndpoint API.
GetSteeringPolicy(GetSteeringPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified steering policy.
Declaration
public Task<GetSteeringPolicyResponse> GetSteeringPolicy(GetSteeringPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSteeringPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSteeringPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSteeringPolicy API.
GetSteeringPolicyAttachment(GetSteeringPolicyAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified steering policy attachment.
Declaration
public Task<GetSteeringPolicyAttachmentResponse> GetSteeringPolicyAttachment(GetSteeringPolicyAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSteeringPolicyAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSteeringPolicyAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSteeringPolicyAttachment API.
GetTsigKey(GetTsigKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified TSIG key.
Declaration
public Task<GetTsigKeyResponse> GetTsigKey(GetTsigKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTsigKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTsigKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTsigKey API.
GetView(GetViewRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about a specific view.
<br/>
Note that attempting to get a
view in the DELETED lifecycleState will result in a 404
response to be
consistent with other operations of the API.
Declaration
public Task<GetViewResponse> GetView(GetViewRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetViewRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetViewResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetView API.
GetZone(GetZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified zone, including its creation date, zone type, and serial.
<br/>
When the zone name is provided as a path parameter and PRIVATE
is used for the scope query
parameter then the viewId query parameter is required.
Declaration
public Task<GetZoneResponse> GetZone(GetZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetZoneRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetZone API.
GetZoneContent(GetZoneContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the requested zone's zone file.
Declaration
public Task<GetZoneContentResponse> GetZoneContent(GetZoneContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetZoneContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetZoneContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetZoneContent API.
GetZoneRecords(GetZoneRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets all records in the specified zone.
<br/>
The results are sorted by domain
in alphabetical order by default. For more information about records,
see Resource Record (RR) TYPEs.
When the zone name is provided as a path parameter and PRIVATE
is used for the scope query parameter
then the viewId query parameter is required.
Declaration
public Task<GetZoneRecordsResponse> GetZoneRecords(GetZoneRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetZoneRecordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetZoneRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetZoneRecords API.
ListResolverEndpoints(ListResolverEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state. It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolver endpoints in the DELETED lifecycle state to be consistent with other operations of the API.
Declaration
public Task<ListResolverEndpointsResponse> ListResolverEndpoints(ListResolverEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResolverEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListResolverEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResolverEndpoints API.
ListResolvers(ListResolversRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all resolvers within a compartment. <br/> The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolvers in the DELETED lifecycleState to be consistent with other operations of the API.
Declaration
public Task<ListResolversResponse> ListResolvers(ListResolversRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResolversRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListResolversResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResolvers API.
ListSteeringPolicies(ListSteeringPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all steering policies in the specified compartment.
Declaration
public Task<ListSteeringPoliciesResponse> ListSteeringPolicies(ListSteeringPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSteeringPoliciesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSteeringPoliciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSteeringPolicies API.
ListSteeringPolicyAttachments(ListSteeringPolicyAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the steering policy attachments in the specified compartment.
Declaration
public Task<ListSteeringPolicyAttachmentsResponse> ListSteeringPolicyAttachments(ListSteeringPolicyAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSteeringPolicyAttachmentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSteeringPolicyAttachmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSteeringPolicyAttachments API.
ListTsigKeys(ListTsigKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all TSIG keys in the specified compartment.
Declaration
public Task<ListTsigKeysResponse> ListTsigKeys(ListTsigKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTsigKeysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTsigKeysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTsigKeys API.
ListViews(ListViewsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all views within a compartment. <br/> The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include views in the DELETED lifecycleState to be consistent with other operations of the API.
Declaration
public Task<ListViewsResponse> ListViews(ListViewsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListViewsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListViewsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListViews API.
ListZoneTransferServers(ListZoneTransferServersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of IP addresses of OCI nameservers for inbound and outbound transfer of zones in the specified compartment (which must be the root compartment of a tenancy) that transfer zone data with external master or downstream nameservers.
Declaration
public Task<ListZoneTransferServersResponse> ListZoneTransferServers(ListZoneTransferServersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListZoneTransferServersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListZoneTransferServersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListZoneTransferServers API.
ListZones(ListZonesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all zones in the specified compartment. <br/> The collection can be filtered by name, time created, scope, associated view, and zone type. Filtering by view is only supported for private zones.
Declaration
public Task<ListZonesResponse> ListZones(ListZonesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListZonesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListZonesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListZones API.
PatchDomainRecords(PatchDomainRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates records in the specified zone at a domain.
<br/>
You can update one record or all records for the specified zone depending on the changes provided in the
request body. You can also add or remove records using this function. When the zone name is provided as
a path parameter and PRIVATE
is used for the scope query parameter then the viewId query parameter is
required.
Declaration
public Task<PatchDomainRecordsResponse> PatchDomainRecords(PatchDomainRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PatchDomainRecordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PatchDomainRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PatchDomainRecords API.
PatchRRSet(PatchRRSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates records in the specified RRSet.
<br/>
When the zone name is provided as a path parameter and PRIVATE
is used for the scope query
parameter then the viewId query parameter is required.
Declaration
public Task<PatchRRSetResponse> PatchRRSet(PatchRRSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PatchRRSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PatchRRSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PatchRRSet API.
PatchZoneRecords(PatchZoneRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a collection of records in the specified zone.
<br/>
You can update one record or all records for the specified zone depending on the changes provided in the
request body. You can also add or remove records using this function. When the zone name is provided as
a path parameter and PRIVATE
is used for the scope query parameter then the viewId query parameter is
required.
Declaration
public Task<PatchZoneRecordsResponse> PatchZoneRecords(PatchZoneRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PatchZoneRecordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PatchZoneRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PatchZoneRecords API.
PromoteZoneDnssecKeyVersion(PromoteZoneDnssecKeyVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Promotes a specified DnssecKeyVersion
on the zone.
<br/>
If the DnssecKeyVersion
identified in the request body is a key signing key (KSK) that is replacing
another DnssecKeyVersion
, then the old DnssecKeyVersion
is scheduled for removal from the zone.
<br/>
For key signing keys (KSKs), you must create the DS record with the new key information before promoting
the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon
as its TTL (time to live) expires.
<br/>
For more information, see DNSSEC.
Declaration
public Task<PromoteZoneDnssecKeyVersionResponse> PromoteZoneDnssecKeyVersion(PromoteZoneDnssecKeyVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PromoteZoneDnssecKeyVersionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PromoteZoneDnssecKeyVersionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PromoteZoneDnssecKeyVersion API.
StageZoneDnssecKeyVersion(StageZoneDnssecKeyVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Stages a new DnssecKeyVersion
on the zone. Staging is a process that generates a new "successor" key version
that replaces an existing "predecessor" key version.
Note: A new key-signing key (KSK) version is inert until you update the parent zone DS records.
<br/>
For more information, see the DNSSEC documentation.
Declaration
public Task<StageZoneDnssecKeyVersionResponse> StageZoneDnssecKeyVersion(StageZoneDnssecKeyVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StageZoneDnssecKeyVersionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StageZoneDnssecKeyVersionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StageZoneDnssecKeyVersion API.
UpdateDomainRecords(UpdateDomainRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Replaces records in the specified zone at a domain with the records specified in the request body.
<br/>
If a specified record does not exist, it will be created. If the record exists, then it will be updated to
represent the record in the body of the request. If a record in the zone does not exist in the request body,
the record will be removed from the zone. When the zone name is provided as a path parameter and PRIVATE
is used for the scope query parameter then the viewId query parameter is required.
Declaration
public Task<UpdateDomainRecordsResponse> UpdateDomainRecords(UpdateDomainRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDomainRecordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDomainRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDomainRecords API.
UpdateRRSet(UpdateRRSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Replaces records in the specified RRSet.
<br/>
When the zone name is provided as a path parameter and PRIVATE
is used for the scope
query parameter then the viewId query parameter is required.
Declaration
public Task<UpdateRRSetResponse> UpdateRRSet(UpdateRRSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRRSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateRRSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRRSet API.
UpdateResolver(UpdateResolverRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified resolver with your new information.
Declaration
public Task<UpdateResolverResponse> UpdateResolver(UpdateResolverRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateResolverRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateResolverResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateResolver API.
UpdateResolverEndpoint(UpdateResolverEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified resolver endpoint with your new information.
Declaration
public Task<UpdateResolverEndpointResponse> UpdateResolverEndpoint(UpdateResolverEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateResolverEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateResolverEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateResolverEndpoint API.
UpdateSteeringPolicy(UpdateSteeringPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the configuration of the specified steering policy.
Declaration
public Task<UpdateSteeringPolicyResponse> UpdateSteeringPolicy(UpdateSteeringPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSteeringPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSteeringPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSteeringPolicy API.
UpdateSteeringPolicyAttachment(UpdateSteeringPolicyAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified steering policy attachment with your new information.
Declaration
public Task<UpdateSteeringPolicyAttachmentResponse> UpdateSteeringPolicyAttachment(UpdateSteeringPolicyAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSteeringPolicyAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSteeringPolicyAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSteeringPolicyAttachment API.
UpdateTsigKey(UpdateTsigKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified TSIG key.
Declaration
public Task<UpdateTsigKeyResponse> UpdateTsigKey(UpdateTsigKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTsigKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTsigKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTsigKey API.
UpdateView(UpdateViewRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified view with your new information.
Declaration
public Task<UpdateViewResponse> UpdateView(UpdateViewRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateViewRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateViewResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateView API.
UpdateZone(UpdateZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the zone with the specified information.
<br/>
Global secondary zones may have their external masters updated. For more information about secondary
zones, see Manage DNS Service Zone. When the zone name
is provided as a path parameter and PRIVATE
is used for the scope query parameter then the viewId
query parameter is required.
Declaration
public Task<UpdateZoneResponse> UpdateZone(UpdateZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateZoneRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateZone API.
UpdateZoneRecords(UpdateZoneRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Replaces records in the specified zone with the records specified in the request body.
<br/>
If a specified record does not exist, it will be created. If the record exists, then it will be updated
to represent the record in the body of the request. If a record in the zone does not exist in the
request body, the record will be removed from the zone. When the zone name is provided as a path
parameter and PRIVATE
is used for the scope query parameter then the viewId query parameter is
required.
Declaration
public Task<UpdateZoneRecordsResponse> UpdateZoneRecords(UpdateZoneRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateZoneRecordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateZoneRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateZoneRecords API.