Class: Azure::ContainerService::Mgmt::V2020_12_01::ContainerServiceClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::ContainerService::Mgmt::V2020_12_01::ContainerServiceClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb
Overview
A service client - single point of access to the REST API.
Instance Attribute Summary collapse
-
#accept_language ⇒ String
The preferred language for the response.
-
#agent_pools ⇒ AgentPools
readonly
Agent_pools.
-
#api_version ⇒ String
readonly
Client Api Version.
-
#base_url ⇒ String
The base URI of the service.
-
#credentials ⇒ Object
readonly
Credentials needed for the client to connect to Azure.
-
#generate_client_request_id ⇒ Boolean
generated.
-
#long_running_operation_retry_timeout ⇒ Integer
Operations.
-
#maintenance_configurations ⇒ MaintenanceConfigurations
readonly
Maintenance_configurations.
-
#managed_clusters ⇒ ManagedClusters
readonly
Managed_clusters.
-
#operations ⇒ Operations
readonly
Operations.
-
#private_endpoint_connections ⇒ PrivateEndpointConnections
readonly
Private_endpoint_connections.
-
#private_link_resources ⇒ PrivateLinkResources
readonly
Private_link_resources.
-
#resolve_private_link_service_id ⇒ ResolvePrivateLinkServiceId
readonly
Resolve_private_link_service_id.
-
#subscription_id ⇒ String
Microsoft Azure subscription.
Instance Method Summary collapse
-
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ ContainerServiceClient
constructor
Creates initializes a new instance of the ContainerServiceClient class.
-
#make_request(method, path, options = {}) ⇒ Hash{String=>String}
Makes a request and returns the body of the response.
-
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
-
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
Constructor Details
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ ContainerServiceClient
Creates initializes a new instance of the ContainerServiceClient class.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 67 def initialize(credentials = nil, base_url = nil, = nil) super(credentials, ) @base_url = base_url || 'https://management.azure.com' fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil? @credentials = credentials @operations = Operations.new(self) @managed_clusters = ManagedClusters.new(self) @maintenance_configurations = MaintenanceConfigurations.new(self) @agent_pools = AgentPools.new(self) @private_endpoint_connections = PrivateEndpointConnections.new(self) @private_link_resources = PrivateLinkResources.new(self) @resolve_private_link_service_id = ResolvePrivateLinkServiceId.new(self) @api_version = '2020-12-01' @accept_language = 'en-US' @long_running_operation_retry_timeout = 30 @generate_client_request_id = true add_telemetry end |
Instance Attribute Details
#accept_language ⇒ String
Returns The preferred language for the response.
29 30 31 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 29 def accept_language @accept_language end |
#agent_pools ⇒ AgentPools (readonly)
Returns agent_pools.
50 51 52 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 50 def agent_pools @agent_pools end |
#api_version ⇒ String (readonly)
Returns Client Api Version.
26 27 28 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 26 def api_version @api_version end |
#base_url ⇒ String
Returns the base URI of the service.
15 16 17 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 15 def base_url @base_url end |
#credentials ⇒ Object (readonly)
Returns Credentials needed for the client to connect to Azure.
18 19 20 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 18 def credentials @credentials end |
#generate_client_request_id ⇒ Boolean
generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
38 39 40 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 38 def generate_client_request_id @generate_client_request_id end |
#long_running_operation_retry_timeout ⇒ Integer
Operations. Default value is 30.
33 34 35 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 33 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#maintenance_configurations ⇒ MaintenanceConfigurations (readonly)
Returns maintenance_configurations.
47 48 49 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 47 def maintenance_configurations @maintenance_configurations end |
#managed_clusters ⇒ ManagedClusters (readonly)
Returns managed_clusters.
44 45 46 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 44 def managed_clusters @managed_clusters end |
#operations ⇒ Operations (readonly)
Returns operations.
41 42 43 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 41 def operations @operations end |
#private_endpoint_connections ⇒ PrivateEndpointConnections (readonly)
Returns private_endpoint_connections.
53 54 55 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 53 def private_endpoint_connections @private_endpoint_connections end |
#private_link_resources ⇒ PrivateLinkResources (readonly)
Returns private_link_resources.
56 57 58 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 56 def private_link_resources @private_link_resources end |
#resolve_private_link_service_id ⇒ ResolvePrivateLinkServiceId (readonly)
Returns resolve_private_link_service_id.
59 60 61 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 59 def resolve_private_link_service_id @resolve_private_link_service_id end |
#subscription_id ⇒ String
Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
23 24 25 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 23 def subscription_id @subscription_id end |
Instance Method Details
#make_request(method, path, options = {}) ⇒ Hash{String=>String}
Makes a request and returns the body of the response. Example:
request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
= {
body: request_content,
query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, )
104 105 106 107 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 104 def make_request(method, path, = {}) result = make_request_with_http_info(method, path, ) result.body unless result.nil? end |
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 129 def make_request_async(method, path, = {}) fail ArgumentError, 'method is nil' if method.nil? fail ArgumentError, 'path is nil' if path.nil? request_url = [:base_url] || @base_url if(![:headers].nil? && ![:headers]['Content-Type'].nil?) @request_headers['Content-Type'] = [:headers]['Content-Type'] end request_headers = @request_headers request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil? .merge!({headers: request_headers.merge([:headers] || {})}) .merge!({credentials: @credentials}) unless @credentials.nil? super(request_url, method, path, ) end |
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
116 117 118 119 120 |
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/container_service_client.rb', line 116 def make_request_with_http_info(method, path, = {}) result = make_request_async(method, path, ).value! result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body) result end |