Class: Azure::DataShare::Mgmt::V2019_11_01::Invitations
- Inherits:
-
Object
- Object
- Azure::DataShare::Mgmt::V2019_11_01::Invitations
- Includes:
- MsRestAzure
- Defined in:
- lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb
Overview
Creates a Microsoft.DataShare management client.
Instance Attribute Summary collapse
-
#client ⇒ DataShareManagementClient
readonly
Reference to the DataShareManagementClient.
Instance Method Summary collapse
-
#create(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers: nil) ⇒ Invitation
Sends a new invitation to a recipient to access a share.
-
#create_async(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers: nil) ⇒ Concurrent::Promise
Sends a new invitation to a recipient to access a share.
-
#create_with_http_info(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Sends a new invitation to a recipient to access a share.
-
#delete(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Object
Delete Invitation in a share.
-
#delete_async(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Concurrent::Promise
Delete Invitation in a share.
-
#delete_with_http_info(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Delete Invitation in a share.
-
#get(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Invitation
Get Invitation in a share.
-
#get_async(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Concurrent::Promise
Get Invitation in a share.
-
#get_with_http_info(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get Invitation in a share.
-
#initialize(client) ⇒ Invitations
constructor
Creates and initializes a new instance of the Invitations class.
-
#list_by_share(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ Array<Invitation>
List all Invitations in a share.
-
#list_by_share_as_lazy(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ InvitationList
List all Invitations in a share.
-
#list_by_share_async(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise
List all Invitations in a share.
-
#list_by_share_next(next_page_link, custom_headers: nil) ⇒ InvitationList
List all Invitations in a share.
-
#list_by_share_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
List all Invitations in a share.
-
#list_by_share_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
List all Invitations in a share.
-
#list_by_share_with_http_info(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
List all Invitations in a share.
Constructor Details
#initialize(client) ⇒ Invitations
Creates and initializes a new instance of the Invitations class.
17 18 19 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 17 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ DataShareManagementClient (readonly)
Returns reference to the DataShareManagementClient.
22 23 24 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 22 def client @client end |
Instance Method Details
#create(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers: nil) ⇒ Invitation
Sends a new invitation to a recipient to access a share.
Create an invitation
will be added to the HTTP request.
147 148 149 150 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 147 def create(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers:nil) response = create_async(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_async(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers: nil) ⇒ Concurrent::Promise
Sends a new invitation to a recipient to access a share.
Create an invitation
to the HTTP request.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 186 def create_async(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'account_name is nil' if account_name.nil? fail ArgumentError, 'share_name is nil' if share_name.nil? fail ArgumentError, 'invitation_name is nil' if invitation_name.nil? fail ArgumentError, 'invitation is nil' if invitation.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? # Serialize Request request_mapper = Azure::DataShare::Mgmt::V2019_11_01::Models::Invitation.mapper() request_content = @client.serialize(request_mapper, invitation) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => account_name,'shareName' => share_name,'invitationName' => invitation_name}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 201 || status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 201 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::DataShare::Mgmt::V2019_11_01::Models::Invitation.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::DataShare::Mgmt::V2019_11_01::Models::Invitation.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#create_with_http_info(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Sends a new invitation to a recipient to access a share.
Create an invitation
will be added to the HTTP request.
167 168 169 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 167 def create_with_http_info(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers:nil) create_async(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers:custom_headers).value! end |
#delete(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Object
Delete Invitation in a share.
Delete an invitation in a share
will be added to the HTTP request.
274 275 276 277 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 274 def delete(resource_group_name, account_name, share_name, invitation_name, custom_headers:nil) response = delete_async(resource_group_name, account_name, share_name, invitation_name, custom_headers:custom_headers).value! nil end |
#delete_async(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Concurrent::Promise
Delete Invitation in a share.
Delete an invitation in a share
to the HTTP request.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 311 def delete_async(resource_group_name, account_name, share_name, invitation_name, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'account_name is nil' if account_name.nil? fail ArgumentError, 'share_name is nil' if share_name.nil? fail ArgumentError, 'invitation_name is nil' if invitation_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => account_name,'shareName' => share_name,'invitationName' => invitation_name}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:delete, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 || status_code == 204 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? result end promise.execute end |
#delete_with_http_info(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Delete Invitation in a share.
Delete an invitation in a share
will be added to the HTTP request.
293 294 295 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 293 def delete_with_http_info(resource_group_name, account_name, share_name, invitation_name, custom_headers:nil) delete_async(resource_group_name, account_name, share_name, invitation_name, custom_headers:custom_headers).value! end |
#get(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Invitation
Get Invitation in a share.
Get an invitation in a share
will be added to the HTTP request.
38 39 40 41 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 38 def get(resource_group_name, account_name, share_name, invitation_name, custom_headers:nil) response = get_async(resource_group_name, account_name, share_name, invitation_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ Concurrent::Promise
Get Invitation in a share.
Get an invitation in a share
to the HTTP request.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 75 def get_async(resource_group_name, account_name, share_name, invitation_name, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'account_name is nil' if account_name.nil? fail ArgumentError, 'share_name is nil' if share_name.nil? fail ArgumentError, 'invitation_name is nil' if invitation_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => account_name,'shareName' => share_name,'invitationName' => invitation_name}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::DataShare::Mgmt::V2019_11_01::Models::Invitation.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_with_http_info(resource_group_name, account_name, share_name, invitation_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get Invitation in a share.
Get an invitation in a share
will be added to the HTTP request.
57 58 59 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 57 def get_with_http_info(resource_group_name, account_name, share_name, invitation_name, custom_headers:nil) get_async(resource_group_name, account_name, share_name, invitation_name, custom_headers:custom_headers).value! end |
#list_by_share(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ Array<Invitation>
List all Invitations in a share.
List invitations in a share
will be added to the HTTP request.
372 373 374 375 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 372 def list_by_share(resource_group_name, account_name, share_name, skip_token:nil, custom_headers:nil) first_page = list_by_share_as_lazy(resource_group_name, account_name, share_name, skip_token:skip_token, custom_headers:custom_headers) first_page.get_all_items end |
#list_by_share_as_lazy(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ InvitationList
List all Invitations in a share.
List invitations in a share
will be added to the HTTP request.
575 576 577 578 579 580 581 582 583 584 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 575 def list_by_share_as_lazy(resource_group_name, account_name, share_name, skip_token:nil, custom_headers:nil) response = list_by_share_async(resource_group_name, account_name, share_name, skip_token:skip_token, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_share_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_by_share_async(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise
List all Invitations in a share.
List invitations in a share
to the HTTP request.
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 409 def list_by_share_async(resource_group_name, account_name, share_name, skip_token:nil, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'account_name is nil' if account_name.nil? fail ArgumentError, 'share_name is nil' if share_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => account_name,'shareName' => share_name}, query_params: {'api-version' => @client.api_version,'$skipToken' => skip_token}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::DataShare::Mgmt::V2019_11_01::Models::InvitationList.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_by_share_next(next_page_link, custom_headers: nil) ⇒ InvitationList
List all Invitations in a share.
List invitations in a share
to List operation. will be added to the HTTP request.
477 478 479 480 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 477 def list_by_share_next(next_page_link, custom_headers:nil) response = list_by_share_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_by_share_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
List all Invitations in a share.
List invitations in a share
to List operation. to the HTTP request.
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 510 def list_by_share_next_async(next_page_link, custom_headers:nil) fail ArgumentError, 'next_page_link is nil' if next_page_link.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = '{nextLink}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'nextLink' => next_page_link}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::DataShare::Mgmt::V2019_11_01::Models::InvitationList.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_by_share_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
List all Invitations in a share.
List invitations in a share
to List operation. will be added to the HTTP request.
494 495 496 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 494 def list_by_share_next_with_http_info(next_page_link, custom_headers:nil) list_by_share_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_by_share_with_http_info(resource_group_name, account_name, share_name, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
List all Invitations in a share.
List invitations in a share
will be added to the HTTP request.
391 392 393 |
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/invitations.rb', line 391 def list_by_share_with_http_info(resource_group_name, account_name, share_name, skip_token:nil, custom_headers:nil) list_by_share_async(resource_group_name, account_name, share_name, skip_token:skip_token, custom_headers:custom_headers).value! end |